Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/batch

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AccessScope

AccessScope: "job"

Defines values for AccessScope. Possible values include: 'job'

readonly
enum

{string}

AccountListNodeAgentSkusResponse

AccountListNodeAgentSkusResponse: AccountListNodeAgentSkusResult & AccountListNodeAgentSkusHeaders & object

Contains response data for the listNodeAgentSkus operation.

AccountListPoolNodeCountsResponse

AccountListPoolNodeCountsResponse: PoolNodeCountsListResult & AccountListPoolNodeCountsHeaders & object

Contains response data for the listPoolNodeCounts operation.

AllocationState

AllocationState: "steady" | "resizing" | "stopping"

Defines values for AllocationState. Possible values include: 'steady', 'resizing', 'stopping'

readonly
enum

{string}

ApplicationGetResponse

ApplicationGetResponse: ApplicationSummary & ApplicationGetHeaders & object

Contains response data for the get operation.

ApplicationListResponse

ApplicationListResponse: ApplicationListResult & ApplicationListHeaders & object

Contains response data for the list operation.

AutoUserScope

AutoUserScope: "task" | "pool"

Defines values for AutoUserScope. Possible values include: 'task', 'pool'

readonly
enum

{string}

CachingType

CachingType: "none" | "readonly" | "readwrite"

Defines values for CachingType. Possible values include: 'none', 'readOnly', 'readWrite'

readonly
enum

{string}

CertificateAddResponse

CertificateAddResponse: CertificateAddHeaders & object

Contains response data for the add operation.

CertificateCancelDeletionResponse

CertificateCancelDeletionResponse: CertificateCancelDeletionHeaders & object

Contains response data for the cancelDeletion operation.

CertificateDeleteResponse

CertificateDeleteResponse: CertificateDeleteHeaders & object

Contains response data for the deleteMethod operation.

CertificateFormat

CertificateFormat: "pfx" | "cer"

Defines values for CertificateFormat. Possible values include: 'pfx', 'cer'

readonly
enum

{string}

CertificateGetResponse

CertificateGetResponse: Certificate & CertificateGetHeaders & object

Contains response data for the get operation.

CertificateListResponse

CertificateListResponse: CertificateListResult & CertificateListHeaders & object

Contains response data for the list operation.

CertificateState

CertificateState: "active" | "deleting" | "deletefailed"

Defines values for CertificateState. Possible values include: 'active', 'deleting', 'deleteFailed'

readonly
enum

{string}

CertificateStoreLocation

CertificateStoreLocation: "currentuser" | "localmachine"

Defines values for CertificateStoreLocation. Possible values include: 'currentUser', 'localMachine'

readonly
enum

{string}

CertificateVisibility

CertificateVisibility: "starttask" | "task" | "remoteuser"

Defines values for CertificateVisibility. Possible values include: 'startTask', 'task', 'remoteUser'

readonly
enum

{string}

ComputeNodeAddUserResponse

ComputeNodeAddUserResponse: ComputeNodeAddUserHeaders & object

Contains response data for the addUser operation.

ComputeNodeDeallocationOption

ComputeNodeDeallocationOption: "requeue" | "terminate" | "taskcompletion" | "retaineddata"

Defines values for ComputeNodeDeallocationOption. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

readonly
enum

{string}

ComputeNodeDeleteUserResponse

ComputeNodeDeleteUserResponse: ComputeNodeDeleteUserHeaders & object

Contains response data for the deleteUser operation.

ComputeNodeDisableSchedulingResponse

ComputeNodeDisableSchedulingResponse: ComputeNodeDisableSchedulingHeaders & object

Contains response data for the disableScheduling operation.

ComputeNodeEnableSchedulingResponse

ComputeNodeEnableSchedulingResponse: ComputeNodeEnableSchedulingHeaders & object

Contains response data for the enableScheduling operation.

ComputeNodeFillType

ComputeNodeFillType: "spread" | "pack"

Defines values for ComputeNodeFillType. Possible values include: 'spread', 'pack'

readonly
enum

{string}

ComputeNodeGetRemoteDesktopResponse

ComputeNodeGetRemoteDesktopResponse: ComputeNodeGetRemoteDesktopHeaders & object

Contains response data for the getRemoteDesktop operation.

ComputeNodeGetRemoteLoginSettingsResponse

ComputeNodeGetRemoteLoginSettingsResponse: ComputeNodeGetRemoteLoginSettingsResult & ComputeNodeGetRemoteLoginSettingsHeaders & object

Contains response data for the getRemoteLoginSettings operation.

ComputeNodeGetResponse

ComputeNodeGetResponse: ComputeNode & ComputeNodeGetHeaders & object

Contains response data for the get operation.

ComputeNodeListResponse

ComputeNodeListResponse: ComputeNodeListResult & ComputeNodeListHeaders & object

Contains response data for the list operation.

ComputeNodeRebootOption

ComputeNodeRebootOption: "requeue" | "terminate" | "taskcompletion" | "retaineddata"

Defines values for ComputeNodeRebootOption. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

readonly
enum

{string}

ComputeNodeRebootResponse

ComputeNodeRebootResponse: ComputeNodeRebootHeaders & object

Contains response data for the reboot operation.

ComputeNodeReimageOption

ComputeNodeReimageOption: "requeue" | "terminate" | "taskcompletion" | "retaineddata"

Defines values for ComputeNodeReimageOption. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

readonly
enum

{string}

ComputeNodeReimageResponse

ComputeNodeReimageResponse: ComputeNodeReimageHeaders & object

Contains response data for the reimage operation.

ComputeNodeState

ComputeNodeState: "idle" | "rebooting" | "reimaging" | "running" | "unusable" | "creating" | "starting" | "waitingforstarttask" | "starttaskfailed" | "unknown" | "leavingpool" | "offline" | "preempted"

Defines values for ComputeNodeState. Possible values include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted'

readonly
enum

{string}

ComputeNodeUpdateUserResponse

ComputeNodeUpdateUserResponse: ComputeNodeUpdateUserHeaders & object

Contains response data for the updateUser operation.

ComputeNodeUploadBatchServiceLogsResponse

ComputeNodeUploadBatchServiceLogsResponse: UploadBatchServiceLogsResult & ComputeNodeUploadBatchServiceLogsHeaders & object

Contains response data for the uploadBatchServiceLogs operation.

DependencyAction

DependencyAction: "satisfy" | "block"

Defines values for DependencyAction. Possible values include: 'satisfy', 'block'

readonly
enum

{string}

DisableComputeNodeSchedulingOption

DisableComputeNodeSchedulingOption: "requeue" | "terminate" | "taskcompletion"

Defines values for DisableComputeNodeSchedulingOption. Possible values include: 'requeue', 'terminate', 'taskCompletion'

readonly
enum

{string}

DisableJobOption

DisableJobOption: "requeue" | "terminate" | "wait"

Defines values for DisableJobOption. Possible values include: 'requeue', 'terminate', 'wait'

readonly
enum

{string}

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope: "none" | "job"

Defines values for DynamicVNetAssignmentScope. Possible values include: 'none', 'job'

readonly
enum

{string}

ElevationLevel

ElevationLevel: "nonadmin" | "admin"

Defines values for ElevationLevel. Possible values include: 'nonAdmin', 'admin'

readonly
enum

{string}

ErrorCategory

ErrorCategory: "usererror" | "servererror"

Defines values for ErrorCategory. Possible values include: 'userError', 'serverError'

readonly
enum

{string}

FileDeleteFromComputeNodeResponse

FileDeleteFromComputeNodeResponse: FileDeleteFromComputeNodeHeaders & object

Contains response data for the deleteFromComputeNode operation.

FileDeleteFromTaskResponse

FileDeleteFromTaskResponse: FileDeleteFromTaskHeaders & object

Contains response data for the deleteFromTask operation.

FileGetFromComputeNodeResponse

FileGetFromComputeNodeResponse: FileGetFromComputeNodeHeaders & object

Contains response data for the getFromComputeNode operation.

FileGetFromTaskResponse

FileGetFromTaskResponse: FileGetFromTaskHeaders & object

Contains response data for the getFromTask operation.

FileGetPropertiesFromComputeNodeResponse

FileGetPropertiesFromComputeNodeResponse: FileGetPropertiesFromComputeNodeHeaders & object

Contains response data for the getPropertiesFromComputeNode operation.

FileGetPropertiesFromTaskResponse

FileGetPropertiesFromTaskResponse: FileGetPropertiesFromTaskHeaders & object

Contains response data for the getPropertiesFromTask operation.

FileListFromComputeNodeResponse

FileListFromComputeNodeResponse: NodeFileListResult & FileListFromComputeNodeHeaders & object

Contains response data for the listFromComputeNode operation.

FileListFromTaskResponse

FileListFromTaskResponse: NodeFileListResult & FileListFromTaskHeaders & object

Contains response data for the listFromTask operation.

InboundEndpointProtocol

InboundEndpointProtocol: "tcp" | "udp"

Defines values for InboundEndpointProtocol. Possible values include: 'tcp', 'udp'

readonly
enum

{string}

JobAction

JobAction: "none" | "disable" | "terminate"

Defines values for JobAction. Possible values include: 'none', 'disable', 'terminate'

readonly
enum

{string}

JobAddResponse

JobAddResponse: JobAddHeaders & object

Contains response data for the add operation.

JobDeleteResponse

JobDeleteResponse: JobDeleteHeaders & object

Contains response data for the deleteMethod operation.

JobDisableResponse

JobDisableResponse: JobDisableHeaders & object

Contains response data for the disable operation.

JobEnableResponse

JobEnableResponse: JobEnableHeaders & object

Contains response data for the enable operation.

JobGetAllLifetimeStatisticsResponse

JobGetAllLifetimeStatisticsResponse: JobStatistics & JobGetAllLifetimeStatisticsHeaders & object

Contains response data for the getAllLifetimeStatistics operation.

JobGetResponse

JobGetResponse: CloudJob & JobGetHeaders & object

Contains response data for the get operation.

JobGetTaskCountsResponse

JobGetTaskCountsResponse: TaskCounts & JobGetTaskCountsHeaders & object

Contains response data for the getTaskCounts operation.

JobListFromJobScheduleResponse

JobListFromJobScheduleResponse: CloudJobListResult & JobListFromJobScheduleHeaders & object

Contains response data for the listFromJobSchedule operation.

JobListPreparationAndReleaseTaskStatusResponse

Contains response data for the listPreparationAndReleaseTaskStatus operation.

JobListResponse

JobListResponse: CloudJobListResult & JobListHeaders & object

Contains response data for the list operation.

JobPatchResponse

JobPatchResponse: JobPatchHeaders & object

Contains response data for the patch operation.

JobPreparationTaskState

JobPreparationTaskState: "running" | "completed"

Defines values for JobPreparationTaskState. Possible values include: 'running', 'completed'

readonly
enum

{string}

JobReleaseTaskState

JobReleaseTaskState: "running" | "completed"

Defines values for JobReleaseTaskState. Possible values include: 'running', 'completed'

readonly
enum

{string}

JobScheduleAddResponse

JobScheduleAddResponse: JobScheduleAddHeaders & object

Contains response data for the add operation.

JobScheduleDeleteResponse

JobScheduleDeleteResponse: JobScheduleDeleteHeaders & object

Contains response data for the deleteMethod operation.

JobScheduleDisableResponse

JobScheduleDisableResponse: JobScheduleDisableHeaders & object

Contains response data for the disable operation.

JobScheduleEnableResponse

JobScheduleEnableResponse: JobScheduleEnableHeaders & object

Contains response data for the enable operation.

JobScheduleExistsResponse

JobScheduleExistsResponse: JobScheduleExistsHeaders & object

Contains response data for the exists operation.

JobScheduleGetResponse

JobScheduleGetResponse: CloudJobSchedule & JobScheduleGetHeaders & object

Contains response data for the get operation.

JobScheduleListResponse

JobScheduleListResponse: CloudJobScheduleListResult & JobScheduleListHeaders & object

Contains response data for the list operation.

JobSchedulePatchResponse

JobSchedulePatchResponse: JobSchedulePatchHeaders & object

Contains response data for the patch operation.

JobScheduleState

JobScheduleState: "active" | "completed" | "disabled" | "terminating" | "deleting"

Defines values for JobScheduleState. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'

readonly
enum

{string}

JobScheduleTerminateResponse

JobScheduleTerminateResponse: JobScheduleTerminateHeaders & object

Contains response data for the terminate operation.

JobScheduleUpdateResponse

JobScheduleUpdateResponse: JobScheduleUpdateHeaders & object

Contains response data for the update operation.

JobState

JobState: "active" | "disabling" | "disabled" | "enabling" | "terminating" | "completed" | "deleting"

Defines values for JobState. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'

readonly
enum

{string}

JobTerminateResponse

JobTerminateResponse: JobTerminateHeaders & object

Contains response data for the terminate operation.

JobUpdateResponse

JobUpdateResponse: JobUpdateHeaders & object

Contains response data for the update operation.

LoginMode

LoginMode: "batch" | "interactive"

Defines values for LoginMode. Possible values include: 'batch', 'interactive'

readonly
enum

{string}

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess: "allow" | "deny"

Defines values for NetworkSecurityGroupRuleAccess. Possible values include: 'allow', 'deny'

readonly
enum

{string}

OSType

OSType: "linux" | "windows"

Defines values for OSType. Possible values include: 'linux', 'windows'

readonly
enum

{string}

OnAllTasksComplete

OnAllTasksComplete: "noaction" | "terminatejob"

Defines values for OnAllTasksComplete. Possible values include: 'noAction', 'terminateJob'

readonly
enum

{string}

OnTaskFailure

OnTaskFailure: "noaction" | "performexitoptionsjobaction"

Defines values for OnTaskFailure. Possible values include: 'noAction', 'performExitOptionsJobAction'

readonly
enum

{string}

OutputFileUploadCondition

OutputFileUploadCondition: "tasksuccess" | "taskfailure" | "taskcompletion"

Defines values for OutputFileUploadCondition. Possible values include: 'taskSuccess', 'taskFailure', 'taskCompletion'

readonly
enum

{string}

PoolAddResponse

PoolAddResponse: PoolAddHeaders & object

Contains response data for the add operation.

PoolDeleteResponse

PoolDeleteResponse: PoolDeleteHeaders & object

Contains response data for the deleteMethod operation.

PoolDisableAutoScaleResponse

PoolDisableAutoScaleResponse: PoolDisableAutoScaleHeaders & object

Contains response data for the disableAutoScale operation.

PoolEnableAutoScaleResponse

PoolEnableAutoScaleResponse: PoolEnableAutoScaleHeaders & object

Contains response data for the enableAutoScale operation.

PoolEvaluateAutoScaleResponse

PoolEvaluateAutoScaleResponse: AutoScaleRun & PoolEvaluateAutoScaleHeaders & object

Contains response data for the evaluateAutoScale operation.

PoolExistsResponse

PoolExistsResponse: PoolExistsHeaders & object

Contains response data for the exists operation.

PoolGetAllLifetimeStatisticsResponse

PoolGetAllLifetimeStatisticsResponse: PoolStatistics & PoolGetAllLifetimeStatisticsHeaders & object

Contains response data for the getAllLifetimeStatistics operation.

PoolGetResponse

PoolGetResponse: CloudPool & PoolGetHeaders & object

Contains response data for the get operation.

PoolLifetimeOption

PoolLifetimeOption: "jobschedule" | "job"

Defines values for PoolLifetimeOption. Possible values include: 'jobSchedule', 'job'

readonly
enum

{string}

PoolListResponse

PoolListResponse: CloudPoolListResult & PoolListHeaders & object

Contains response data for the list operation.

PoolListUsageMetricsResponse

PoolListUsageMetricsResponse: PoolListUsageMetricsResult & PoolListUsageMetricsHeaders & object

Contains response data for the listUsageMetrics operation.

PoolPatchResponse

PoolPatchResponse: PoolPatchHeaders & object

Contains response data for the patch operation.

PoolRemoveNodesResponse

PoolRemoveNodesResponse: PoolRemoveNodesHeaders & object

Contains response data for the removeNodes operation.

PoolResizeResponse

PoolResizeResponse: PoolResizeHeaders & object

Contains response data for the resize operation.

PoolState

PoolState: "active" | "deleting"

Defines values for PoolState. Possible values include: 'active', 'deleting'

readonly
enum

{string}

PoolStopResizeResponse

PoolStopResizeResponse: PoolStopResizeHeaders & object

Contains response data for the stopResize operation.

PoolUpdatePropertiesResponse

PoolUpdatePropertiesResponse: PoolUpdatePropertiesHeaders & object

Contains response data for the updateProperties operation.

SchedulingState

SchedulingState: "enabled" | "disabled"

Defines values for SchedulingState. Possible values include: 'enabled', 'disabled'

readonly
enum

{string}

StartTaskState

StartTaskState: "running" | "completed"

Defines values for StartTaskState. Possible values include: 'running', 'completed'

readonly
enum

{string}

StorageAccountType

StorageAccountType: "standard_lrs" | "premium_lrs"

Defines values for StorageAccountType. Possible values include: 'StandardLRS', 'PremiumLRS'

readonly
enum

{string}

SubtaskState

SubtaskState: "preparing" | "running" | "completed"

Defines values for SubtaskState. Possible values include: 'preparing', 'running', 'completed'

readonly
enum

{string}

TaskAddCollectionResponse

TaskAddCollectionResponse: TaskAddCollectionResult & TaskAddCollectionHeaders & object

Contains response data for the addCollection operation.

TaskAddResponse

TaskAddResponse: TaskAddHeaders & object

Contains response data for the add operation.

TaskAddStatus

TaskAddStatus: "success" | "clienterror" | "servererror"

Defines values for TaskAddStatus. Possible values include: 'success', 'clientError', 'serverError'

readonly
enum

{string}

TaskDeleteResponse

TaskDeleteResponse: TaskDeleteHeaders & object

Contains response data for the deleteMethod operation.

TaskExecutionResult

TaskExecutionResult: "success" | "failure"

Defines values for TaskExecutionResult. Possible values include: 'success', 'failure'

readonly
enum

{string}

TaskGetResponse

TaskGetResponse: CloudTask & TaskGetHeaders & object

Contains response data for the get operation.

TaskListResponse

TaskListResponse: CloudTaskListResult & TaskListHeaders & object

Contains response data for the list operation.

TaskListSubtasksResponse

TaskListSubtasksResponse: CloudTaskListSubtasksResult & TaskListSubtasksHeaders & object

Contains response data for the listSubtasks operation.

TaskReactivateResponse

TaskReactivateResponse: TaskReactivateHeaders & object

Contains response data for the reactivate operation.

TaskState

TaskState: "active" | "preparing" | "running" | "completed"

Defines values for TaskState. Possible values include: 'active', 'preparing', 'running', 'completed'

readonly
enum

{string}

TaskTerminateResponse

TaskTerminateResponse: TaskTerminateHeaders & object

Contains response data for the terminate operation.

TaskUpdateResponse

TaskUpdateResponse: TaskUpdateHeaders & object

Contains response data for the update operation.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AccountListNodeAgentSkusHeaders

AccountListNodeAgentSkusHeaders: object

Defines headers for ListNodeAgentSkus operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "account-listnodeagentskus-headers"

type

type: object

className

className: string = "AccountListNodeAgentSkusHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const AccountListNodeAgentSkusNextOptions

AccountListNodeAgentSkusNextOptions: object

Additional parameters for listNodeAgentSkusNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "AccountListNodeAgentSkusNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const AccountListNodeAgentSkusOptions

AccountListNodeAgentSkusOptions: object

Additional parameters for listNodeAgentSkus operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 results will be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "AccountListNodeAgentSkusOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const AccountListNodeAgentSkusResult

AccountListNodeAgentSkusResult: object
interface

An interface representing the AccountListNodeAgentSkusResult.

summary

The result of listing the supported node agent SKUs.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "AccountListNodeAgentSkusResult"

__@iterator

  • Iterator

    Returns IterableIterator<NodeAgentSku>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NodeAgentSku>[]

      Additional items to add to the end of array1.

    Returns NodeAgentSku[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NodeAgentSku[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NodeAgentSku]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NodeAgentSku, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NodeAgentSku

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NodeAgentSku[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NodeAgentSku[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NodeAgentSku | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns NodeAgentSku | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NodeAgentSku, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NodeAgentSku

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NodeAgentSku, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NodeAgentSku

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NodeAgentSku, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NodeAgentSku

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns NodeAgentSku | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NodeAgentSku

  • Parameters

    Returns NodeAgentSku

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NodeAgentSku
  • reduceRight(callbackfn: function, initialValue: NodeAgentSku): NodeAgentSku
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns NodeAgentSku

  • Parameters

    Returns NodeAgentSku

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns NodeAgentSku[]

shift

  • Removes the first element from an array and returns it.

    Returns NodeAgentSku | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NodeAgentSku[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NodeAgentSku[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NodeAgentSku[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NodeAgentSku[]

      Elements to insert into the array in place of the deleted elements.

    Returns NodeAgentSku[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NodeAgentSku[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<NodeAgentSku>

type

type: object

className

className: string = "AccountListNodeAgentSkusResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeAgentSku"

name

name: "Composite" = "Composite"

Const AccountListPoolNodeCountsHeaders

AccountListPoolNodeCountsHeaders: object

Defines headers for ListPoolNodeCounts operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "account-listpoolnodecounts-headers"

type

type: object

className

className: string = "AccountListPoolNodeCountsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const AccountListPoolNodeCountsNextOptions

AccountListPoolNodeCountsNextOptions: object

Additional parameters for listPoolNodeCountsNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "AccountListPoolNodeCountsNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const AccountListPoolNodeCountsOptions

AccountListPoolNodeCountsOptions: object

Additional parameters for listPoolNodeCounts operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. Default value: 10.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "AccountListPoolNodeCountsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 10

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const AffinityInformation

AffinityInformation: object

An interface representing AffinityInformation.

summary

A locality hint that can be used by the Batch service to select a compute node on which to start a task.

affinityId

affinityId: string

An opaque string representing the location of a compute node or a task that has run previously. You can pass the affinityId of a compute node to indicate that this task needs to run on that compute node. Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere.

serializedName

serializedName: string = "AffinityInformation"

type

type: object

className

className: string = "AffinityInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affinityId

affinityId: object

required

required: true = true

serializedName

serializedName: string = "affinityId"

type

type: object

name

name: "String" = "String"

Const ApplicationGetHeaders

ApplicationGetHeaders: object

Defines headers for Get operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "application-get-headers"

type

type: object

className

className: string = "ApplicationGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ApplicationGetOptions

ApplicationGetOptions: object

Additional parameters for get operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ApplicationGetOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ApplicationListHeaders

ApplicationListHeaders: object

Defines headers for List operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "application-list-headers"

type

type: object

className

className: string = "ApplicationListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ApplicationListNextOptions

ApplicationListNextOptions: object

Additional parameters for listNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "ApplicationListNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const ApplicationListOptions

ApplicationListOptions: object

Additional parameters for list operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 applications can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ApplicationListOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ApplicationListResult

ApplicationListResult: object
interface

An interface representing the ApplicationListResult.

summary

The result of listing the applications available in an account.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "ApplicationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ApplicationSummary>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApplicationSummary>[]

      Additional items to add to the end of array1.

    Returns ApplicationSummary[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApplicationSummary[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApplicationSummary]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ApplicationSummary, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApplicationSummary

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApplicationSummary[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApplicationSummary[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApplicationSummary | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ApplicationSummary | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApplicationSummary

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApplicationSummary

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApplicationSummary

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ApplicationSummary | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApplicationSummary

  • Parameters

    Returns ApplicationSummary

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ApplicationSummary

  • Parameters

    Returns ApplicationSummary

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ApplicationSummary[]

shift

  • Removes the first element from an array and returns it.

    Returns ApplicationSummary | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApplicationSummary[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApplicationSummary[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApplicationSummary[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApplicationSummary[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ApplicationSummary>

type

type: object

className

className: string = "ApplicationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationSummary"

name

name: "Composite" = "Composite"

Const ApplicationPackageReference

ApplicationPackageReference: object

An interface representing ApplicationPackageReference.

summary

A reference to an application package to be deployed to compute nodes.

applicationId

applicationId: string

The ID of the application to deploy.

Optional version

version: undefined | string

The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a task, and no default version is specified for this application, the task fails with a pre-processing error.

serializedName

serializedName: string = "ApplicationPackageReference"

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationId

applicationId: object

required

required: true = true

serializedName

serializedName: string = "applicationId"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const ApplicationSummary

ApplicationSummary: object

An interface representing ApplicationSummary.

summary

Contains information about an application in an Azure Batch account.

displayName

displayName: string

The display name for the application.

id

id: string

A string that uniquely identifies the application within the account.

versions

versions: string[]

The list of available versions of the application.

serializedName

serializedName: string = "ApplicationSummary"

type

type: object

className

className: string = "ApplicationSummary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

versions

versions: object

required

required: true = true

serializedName

serializedName: string = "versions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AuthenticationTokenSettings

AuthenticationTokenSettings: object

An interface representing AuthenticationTokenSettings.

summary

The settings for an authentication token that the task can use to perform Batch service operations.

Optional access

access: AccessScope[]

The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the job which contains the task.

serializedName

serializedName: string = "AuthenticationTokenSettings"

type

type: object

className

className: string = "AuthenticationTokenSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

serializedName

serializedName: string = "access"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["job"]

name

name: "Enum" = "Enum"

Const AutoPoolSpecification

AutoPoolSpecification: object

An interface representing AutoPoolSpecification.

summary

Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when the job is submitted.

Optional autoPoolIdPrefix

autoPoolIdPrefix: undefined | string

A prefix to be added to the unique identifier when a pool is automatically created. The Batch service assigns each auto pool a unique identifier on creation. To distinguish between pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long.

Optional keepAlive

keepAlive: undefined | false | true

Whether to keep an auto pool alive after its lifetime expires. If false, the Batch service deletes the pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the job or job schedule completes. If true, the Batch service does not delete the pool automatically. It is up to the user to delete auto pools created with this option.

Optional pool

The pool specification for the auto pool.

poolLifetimeOption

poolLifetimeOption: PoolLifetimeOption

The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools. Possible values include: 'jobSchedule', 'job'

serializedName

serializedName: string = "AutoPoolSpecification"

type

type: object

className

className: string = "AutoPoolSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoPoolIdPrefix

autoPoolIdPrefix: object

serializedName

serializedName: string = "autoPoolIdPrefix"

type

type: object

name

name: "String" = "String"

keepAlive

keepAlive: object

serializedName

serializedName: string = "keepAlive"

type

type: object

name

name: "Boolean" = "Boolean"

pool

pool: object

serializedName

serializedName: string = "pool"

type

type: object

className

className: string = "PoolSpecification"

name

name: "Composite" = "Composite"

poolLifetimeOption

poolLifetimeOption: object

required

required: true = true

serializedName

serializedName: string = "poolLifetimeOption"

type

type: object

allowedValues

allowedValues: string[] = ["jobschedule","job"]

name

name: "Enum" = "Enum"

Const AutoScaleRun

AutoScaleRun: object

An interface representing AutoScaleRun.

summary

The results and errors from an execution of a pool autoscale formula.

Optional error

Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful.

Optional results

results: undefined | string

The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the form $variable=value, and variables are separated by semicolons.

timestamp

timestamp: Date

The time at which the autoscale formula was last evaluated.

serializedName

serializedName: string = "AutoScaleRun"

type

type: object

className

className: string = "AutoScaleRun"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "AutoScaleRunError"

name

name: "Composite" = "Composite"

results

results: object

serializedName

serializedName: string = "results"

type

type: object

name

name: "String" = "String"

timestamp

timestamp: object

required

required: true = true

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: "DateTime" = "DateTime"

Const AutoScaleRunError

AutoScaleRunError: object

An interface representing AutoScaleRunError.

summary

An error that occurred when executing or evaluating a pool autoscale formula.

Optional code

code: undefined | string

An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically.

Optional message

message: undefined | string

A message describing the autoscale error, intended to be suitable for display in a user interface.

Optional values

values: NameValuePair[]

A list of additional error details related to the autoscale error.

serializedName

serializedName: string = "AutoScaleRunError"

type

type: object

className

className: string = "AutoScaleRunError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

Const AutoUserSpecification

AutoUserSpecification: object

An interface representing AutoUserSpecification.

summary

Specifies the parameters for the auto user that runs a task on the Batch service.

Optional elevationLevel

elevationLevel: ElevationLevel

The elevation level of the auto user. The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'

Optional scope

The scope for the auto user. The default value is task. Possible values include: 'task', 'pool'

serializedName

serializedName: string = "AutoUserSpecification"

type

type: object

className

className: string = "AutoUserSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

elevationLevel

elevationLevel: object

serializedName

serializedName: string = "elevationLevel"

type

type: object

allowedValues

allowedValues: string[] = ["nonadmin","admin"]

name

name: "Enum" = "Enum"

scope

scope: object

serializedName

serializedName: string = "scope"

type

type: object

allowedValues

allowedValues: string[] = ["task","pool"]

name

name: "Enum" = "Enum"

Const BatchError

BatchError: object

An interface representing BatchError.

summary

An error response received from the Azure Batch service.

Optional code

code: undefined | string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

Optional message

message: ErrorMessage

A message describing the error, intended to be suitable for display in a user interface.

Optional values

A collection of key-value pairs containing additional details about the error.

serializedName

serializedName: string = "BatchError"

type

type: object

className

className: string = "BatchError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

className

className: string = "ErrorMessage"

name

name: "Composite" = "Composite"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BatchErrorDetail"

name

name: "Composite" = "Composite"

Const BatchErrorDetail

BatchErrorDetail: object

An interface representing BatchErrorDetail.

summary

An item of additional information included in an Azure Batch error response.

Optional key

key: undefined | string

An identifier specifying the meaning of the Value property.

Optional value

value: undefined | string

The additional information included with the error response.

serializedName

serializedName: string = "BatchErrorDetail"

type

type: object

className

className: string = "BatchErrorDetail"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const Certificate

Certificate: object

A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.

Optional deleteCertificateError

deleteCertificateError: DeleteCertificateError

The error that occurred on the last attempt to delete this certificate. This property is set only if the certificate is in the DeleteFailed state.

Optional previousState

previousState: CertificateState

The previous state of the certificate. This property is not set if the certificate is in its initial active state. Possible values include: 'active', 'deleting', 'deleteFailed'

Optional previousStateTransitionTime

previousStateTransitionTime: Date

The time at which the certificate entered its previous state. This property is not set if the certificate is in its initial Active state.

Optional publicData

publicData: undefined | string

The public part of the certificate as a base-64 encoded .cer file.

Optional state

The current state of the certificate. Possible values include: 'active', 'deleting', 'deleteFailed'

Optional stateTransitionTime

stateTransitionTime: Date

The time at which the certificate entered its current state.

Optional thumbprint

thumbprint: undefined | string

The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits.

Optional thumbprintAlgorithm

thumbprintAlgorithm: undefined | string

The algorithm used to derive the thumbprint.

Optional url

url: undefined | string

The URL of the certificate.

serializedName

serializedName: string = "Certificate"

type

type: object

className

className: string = "Certificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deleteCertificateError

deleteCertificateError: object

serializedName

serializedName: string = "deleteCertificateError"

type

type: object

className

className: string = "DeleteCertificateError"

name

name: "Composite" = "Composite"

previousState

previousState: object

serializedName

serializedName: string = "previousState"

type

type: object

allowedValues

allowedValues: string[] = ["active","deleting","deletefailed"]

name

name: "Enum" = "Enum"

previousStateTransitionTime

previousStateTransitionTime: object

serializedName

serializedName: string = "previousStateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

publicData

publicData: object

serializedName

serializedName: string = "publicData"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["active","deleting","deletefailed"]

name

name: "Enum" = "Enum"

stateTransitionTime

stateTransitionTime: object

serializedName

serializedName: string = "stateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

thumbprint

thumbprint: object

serializedName

serializedName: string = "thumbprint"

type

type: object

name

name: "String" = "String"

thumbprintAlgorithm

thumbprintAlgorithm: object

serializedName

serializedName: string = "thumbprintAlgorithm"

type

type: object

name

name: "String" = "String"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const CertificateAddHeaders

CertificateAddHeaders: object

Defines headers for Add operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "certificate-add-headers"

type

type: object

className

className: string = "CertificateAddHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const CertificateAddOptions

CertificateAddOptions: object

Additional parameters for add operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "CertificateAddOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const CertificateAddParameter

CertificateAddParameter: object

An interface representing CertificateAddParameter.

summary

A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.

Optional certificateFormat

certificateFormat: CertificateFormat

The format of the certificate data. Possible values include: 'pfx', 'cer'

data

data: string

The base64-encoded contents of the certificate. The maximum size is 10KB.

Optional password

password: undefined | string

The password to access the certificate's private key. This is required if the certificate format is pfx. It should be omitted if the certificate format is cer.

thumbprint

thumbprint: string

The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed).

thumbprintAlgorithm

thumbprintAlgorithm: string

The algorithm used to derive the thumbprint. This must be sha1.

serializedName

serializedName: string = "CertificateAddParameter"

type

type: object

className

className: string = "CertificateAddParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

certificateFormat

certificateFormat: object

serializedName

serializedName: string = "certificateFormat"

type

type: object

allowedValues

allowedValues: string[] = ["pfx","cer"]

name

name: "Enum" = "Enum"

data

data: object

required

required: true = true

serializedName

serializedName: string = "data"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

required

required: true = true

serializedName

serializedName: string = "thumbprint"

type

type: object

name

name: "String" = "String"

thumbprintAlgorithm

thumbprintAlgorithm: object

required

required: true = true

serializedName

serializedName: string = "thumbprintAlgorithm"

type

type: object

name

name: "String" = "String"

Const CertificateCancelDeletionHeaders

CertificateCancelDeletionHeaders: object

Defines headers for CancelDeletion operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "certificate-canceldeletion-headers"

type

type: object

className

className: string = "CertificateCancelDeletionHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const CertificateCancelDeletionOptions

CertificateCancelDeletionOptions: object

Additional parameters for cancelDeletion operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "CertificateCancelDeletionOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const CertificateDeleteHeaders

CertificateDeleteHeaders: object

Defines headers for Delete operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "certificate-delete-headers"

type

type: object

className

className: string = "CertificateDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const CertificateDeleteMethodOptions

CertificateDeleteMethodOptions: object

Additional parameters for deleteMethod operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "CertificateDeleteMethodOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const CertificateGetHeaders

CertificateGetHeaders: object

Defines headers for Get operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "certificate-get-headers"

type

type: object

className

className: string = "CertificateGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const CertificateGetOptions

CertificateGetOptions: object

Additional parameters for get operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "CertificateGetOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const CertificateListHeaders

CertificateListHeaders: object

Defines headers for List operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "certificate-list-headers"

type

type: object

className

className: string = "CertificateListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const CertificateListNextOptions

CertificateListNextOptions: object

Additional parameters for listNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "CertificateListNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const CertificateListOptions

CertificateListOptions: object

Additional parameters for list operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 certificates can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "CertificateListOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const CertificateListResult

CertificateListResult: object
interface

An interface representing the CertificateListResult.

summary

The result of listing the certificates in the account.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "CertificateListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Certificate>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Certificate>[]

      Additional items to add to the end of array1.

    Returns Certificate[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Certificate[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Certificate]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Certificate, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Certificate

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Certificate[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Certificate[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Certificate | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Certificate | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Certificate, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Certificate

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Certificate, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Certificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Certificate, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Certificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Certificate | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Certificate[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Certificate

  • Parameters

    Returns Certificate

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Certificate
  • reduceRight(callbackfn: function, initialValue: Certificate): Certificate
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns Certificate

  • Parameters

    Returns Certificate

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Certificate[]

shift

  • Removes the first element from an array and returns it.

    Returns Certificate | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Certificate[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Certificate[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Certificate[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Certificate[]

      Elements to insert into the array in place of the deleted elements.

    Returns Certificate[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Certificate[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Certificate>

type

type: object

className

className: string = "CertificateListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Certificate"

name

name: "Composite" = "Composite"

Const CertificateReference

CertificateReference: object

An interface representing CertificateReference.

summary

A reference to a certificate to be installed on compute nodes in a pool.

Optional storeLocation

The location of the certificate store on the compute node into which to install the certificate. The default value is currentuser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. Possible values include: 'currentUser', 'localMachine'

Optional storeName

storeName: undefined | string

The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

thumbprint

thumbprint: string

The thumbprint of the certificate.

thumbprintAlgorithm

thumbprintAlgorithm: string

The algorithm with which the thumbprint is associated. This must be sha1.

Optional visibility

visibility: CertificateVisibility[]

Which user accounts on the compute node should have access to the private data of the certificate. You can specify more than one visibility in this collection. The default is all accounts.

serializedName

serializedName: string = "CertificateReference"

type

type: object

className

className: string = "CertificateReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

storeLocation

storeLocation: object

serializedName

serializedName: string = "storeLocation"

type

type: object

allowedValues

allowedValues: string[] = ["currentuser","localmachine"]

name

name: "Enum" = "Enum"

storeName

storeName: object

serializedName

serializedName: string = "storeName"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

required

required: true = true

serializedName

serializedName: string = "thumbprint"

type

type: object

name

name: "String" = "String"

thumbprintAlgorithm

thumbprintAlgorithm: object

required

required: true = true

serializedName

serializedName: string = "thumbprintAlgorithm"

type

type: object

name

name: "String" = "String"

visibility

visibility: object

serializedName

serializedName: string = "visibility"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["starttask","task","remoteuser"]

name

name: "Enum" = "Enum"

Const CloudJob

CloudJob: object

An interface representing CloudJob.

summary

An Azure Batch job.

Optional commonEnvironmentSettings

commonEnvironmentSettings: EnvironmentSetting[]

The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks). Individual tasks can override an environment setting specified here by specifying the same setting name with a different value.

Optional constraints

constraints: JobConstraints

The execution constraints for the job.

Optional creationTime

creationTime: Date

The creation time of the job.

Optional displayName

displayName: undefined | string

The display name for the job.

Optional eTag

eTag: undefined | string

The ETag of the job. This is an opaque string. You can use it to detect whether the job has changed between requests. In particular, you can be pass the ETag when updating a job to specify that your changes should take effect only if nobody else has modified the job in the meantime.

Optional executionInfo

The execution information for the job.

Optional id

id: undefined | string

A string that uniquely identifies the job within the account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

Optional jobManagerTask

jobManagerTask: JobManagerTask

Details of a Job Manager task to be launched when the job is started.

Optional jobPreparationTask

jobPreparationTask: JobPreparationTask

The Job Preparation task. The Job Preparation task is a special task run on each node before any other task of the job.

Optional jobReleaseTask

jobReleaseTask: JobReleaseTask

The Job Release task. The Job Release task is a special task run at the end of the job on each node that has run any other task of the job.

Optional lastModified

lastModified: Date

The last modified time of the job. This is the last time at which the job level data, such as the job state or priority, changed. It does not factor in task-level changes such as adding new tasks or tasks changing state.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Optional networkConfiguration

networkConfiguration: JobNetworkConfiguration

The network configuration for the job.

Optional onAllTasksComplete

onAllTasksComplete: OnAllTasksComplete

The action the Batch service should take when all tasks in the job are in the completed state. The default is noaction. Possible values include: 'noAction', 'terminateJob'

Optional onTaskFailure

onTaskFailure: OnTaskFailure

The action the Batch service should take when any task in the job fails. A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'

Optional poolInfo

poolInfo: PoolInformation

The pool settings associated with the job.

Optional previousState

previousState: JobState

The previous state of the job. This property is not set if the job is in its initial Active state. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'

Optional previousStateTransitionTime

previousStateTransitionTime: Date

The time at which the job entered its previous state. This property is not set if the job is in its initial Active state.

Optional priority

priority: undefined | number

The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.

Optional state

state: JobState

The current state of the job. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'

Optional stateTransitionTime

stateTransitionTime: Date

The time at which the job entered its current state.

Optional stats

Resource usage statistics for the entire lifetime of the job. This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Optional url

url: undefined | string

The URL of the job.

Optional usesTaskDependencies

usesTaskDependencies: undefined | false | true

Whether tasks in the job can define dependencies on each other. The default is false.

serializedName

serializedName: string = "CloudJob"

type

type: object

className

className: string = "CloudJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commonEnvironmentSettings

commonEnvironmentSettings: object

serializedName

serializedName: string = "commonEnvironmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "JobConstraints"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "eTag"

type

type: object

name

name: "String" = "String"

executionInfo

executionInfo: object

serializedName

serializedName: string = "executionInfo"

type

type: object

className

className: string = "JobExecutionInformation"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

jobManagerTask

jobManagerTask: object

serializedName

serializedName: string = "jobManagerTask"

type

type: object

className

className: string = "JobManagerTask"

name

name: "Composite" = "Composite"

jobPreparationTask

jobPreparationTask: object

serializedName

serializedName: string = "jobPreparationTask"

type

type: object

className

className: string = "JobPreparationTask"

name

name: "Composite" = "Composite"

jobReleaseTask

jobReleaseTask: object

serializedName

serializedName: string = "jobReleaseTask"

type

type: object

className

className: string = "JobReleaseTask"

name

name: "Composite" = "Composite"

lastModified

lastModified: object

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

networkConfiguration

networkConfiguration: object

serializedName

serializedName: string = "networkConfiguration"

type

type: object

className

className: string = "JobNetworkConfiguration"

name

name: "Composite" = "Composite"

onAllTasksComplete

onAllTasksComplete: object

serializedName

serializedName: string = "onAllTasksComplete"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","terminatejob"]

name

name: "Enum" = "Enum"

onTaskFailure

onTaskFailure: object

serializedName

serializedName: string = "onTaskFailure"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","performexitoptionsjobaction"]

name

name: "Enum" = "Enum"

poolInfo

poolInfo: object

serializedName

serializedName: string = "poolInfo"

type

type: object

className

className: string = "PoolInformation"

name

name: "Composite" = "Composite"

previousState

previousState: object

serializedName

serializedName: string = "previousState"

type

type: object

allowedValues

allowedValues: string[] = ["active","disabling","disabled","enabling","terminating","completed","deleting"]

name

name: "Enum" = "Enum"

previousStateTransitionTime

previousStateTransitionTime: object

serializedName

serializedName: string = "previousStateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["active","disabling","disabled","enabling","terminating","completed","deleting"]

name

name: "Enum" = "Enum"

stateTransitionTime

stateTransitionTime: object

serializedName

serializedName: string = "stateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

stats

stats: object

serializedName

serializedName: string = "stats"

type

type: object

className

className: string = "JobStatistics"

name

name: "Composite" = "Composite"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

usesTaskDependencies

usesTaskDependencies: object

serializedName

serializedName: string = "usesTaskDependencies"

type

type: object

name

name: "Boolean" = "Boolean"

Const CloudJobListPreparationAndReleaseTaskStatusResult

CloudJobListPreparationAndReleaseTaskStatusResult: object
interface

An interface representing the CloudJobListPreparationAndReleaseTaskStatusResult.

summary

The result of listing the status of the Job Preparation and Job Release tasks for a job.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "CloudJobListPreparationAndReleaseTaskStatusResult"

__@iterator

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobPreparationAndReleaseTaskExecutionInformation]>

every

  • every(callbackfn: function, thisArg?: any): boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobPreparationAndReleaseTaskExecutionInformation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

find

findIndex

  • findIndex(predicate: function, thisArg?: any): number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobPreparationAndReleaseTaskExecutionInformation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

pop

  • Removes the last element from an array and returns it.

    Returns JobPreparationAndReleaseTaskExecutionInformation | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

shift

  • Removes the first element from an array and returns it.

    Returns JobPreparationAndReleaseTaskExecutionInformation | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobPreparationAndReleaseTaskExecutionInformation[]

some

  • some(callbackfn: function, thisArg?: any): boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobPreparationAndReleaseTaskExecutionInformation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobPreparationAndReleaseTaskExecutionInformation[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobPreparationAndReleaseTaskExecutionInformation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<JobPreparationAndReleaseTaskExecutionInformation>

type

type: object

className

className: string = "CloudJobListPreparationAndReleaseTaskStatusResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobPreparationAndReleaseTaskExecutionInformation"

name

name: "Composite" = "Composite"

Const CloudJobListResult

CloudJobListResult: object
interface

An interface representing the CloudJobListResult.

summary

The result of listing the jobs in an account.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "CloudJobListResult"

__@iterator

  • __@iterator(): IterableIterator<CloudJob>
  • Iterator

    Returns IterableIterator<CloudJob>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CloudJob>[]

      Additional items to add to the end of array1.

    Returns CloudJob[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CloudJob[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, CloudJob]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CloudJob]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CloudJob, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CloudJob

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CloudJob[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CloudJob[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CloudJob | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns CloudJob | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CloudJob, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CloudJob

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CloudJob, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CloudJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CloudJob, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CloudJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CloudJob | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CloudJob[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): CloudJob
  • reduce(callbackfn: function, initialValue: CloudJob): CloudJob
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns CloudJob

  • Parameters

    Returns CloudJob

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudJob, currentIndex: number, array: CloudJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: CloudJob
          • currentIndex: number
          • array: CloudJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): CloudJob
  • reduceRight(callbackfn: function, initialValue: CloudJob): CloudJob
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns CloudJob

  • Parameters

    Returns CloudJob

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudJob, currentIndex: number, array: CloudJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: CloudJob
          • currentIndex: number
          • array: CloudJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CloudJob[]

shift

  • Removes the first element from an array and returns it.

    Returns CloudJob | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CloudJob[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CloudJob[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): CloudJob[]
  • splice(start: number, deleteCount: number, ...items: CloudJob[]): CloudJob[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CloudJob[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CloudJob[]

      Elements to insert into the array in place of the deleted elements.

    Returns CloudJob[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CloudJob[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<CloudJob>

type

type: object

className

className: string = "CloudJobListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CloudJob"

name

name: "Composite" = "Composite"

Const CloudJobSchedule

CloudJobSchedule: object

An interface representing CloudJobSchedule.

summary

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

Optional creationTime

creationTime: Date

The creation time of the job schedule.

Optional displayName

displayName: undefined | string

The display name for the schedule.

Optional eTag

eTag: undefined | string

The ETag of the job schedule. This is an opaque string. You can use it to detect whether the job schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.

Optional executionInfo

Information about jobs that have been and will be run under this schedule.

Optional id

id: undefined | string

A string that uniquely identifies the schedule within the account.

Optional jobSpecification

jobSpecification: JobSpecification

The details of the jobs to be created on this schedule.

Optional lastModified

lastModified: Date

The last modified time of the job schedule. This is the last time at which the schedule level data, such as the job specification or recurrence information, changed. It does not factor in job-level changes such as new jobs being created or jobs changing state.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Optional previousState

previousState: JobScheduleState

The previous state of the job schedule. This property is not present if the job schedule is in its initial active state. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'

Optional previousStateTransitionTime

previousStateTransitionTime: Date

The time at which the job schedule entered its previous state. This property is not present if the job schedule is in its initial active state.

Optional schedule

schedule: Schedule

The schedule according to which jobs will be created.

Optional state

The current state of the job schedule. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'

Optional stateTransitionTime

stateTransitionTime: Date

The time at which the job schedule entered the current state.

Optional stats

The lifetime resource usage statistics for the job schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Optional url

url: undefined | string

The URL of the job schedule.

serializedName

serializedName: string = "CloudJobSchedule"

type

type: object

className

className: string = "CloudJobSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creationTime

creationTime: object

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "eTag"

type

type: object

name

name: "String" = "String"

executionInfo

executionInfo: object

serializedName

serializedName: string = "executionInfo"

type

type: object

className

className: string = "JobScheduleExecutionInformation"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

jobSpecification

jobSpecification: object

serializedName

serializedName: string = "jobSpecification"

type

type: object

className

className: string = "JobSpecification"

name

name: "Composite" = "Composite"

lastModified

lastModified: object

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

previousState

previousState: object

serializedName

serializedName: string = "previousState"

type

type: object

allowedValues

allowedValues: string[] = ["active","completed","disabled","terminating","deleting"]

name

name: "Enum" = "Enum"

previousStateTransitionTime

previousStateTransitionTime: object

serializedName

serializedName: string = "previousStateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

schedule

schedule: object

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["active","completed","disabled","terminating","deleting"]

name

name: "Enum" = "Enum"

stateTransitionTime

stateTransitionTime: object

serializedName

serializedName: string = "stateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

stats

stats: object

serializedName

serializedName: string = "stats"

type

type: object

className

className: string = "JobScheduleStatistics"

name

name: "Composite" = "Composite"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const CloudJobScheduleListResult

CloudJobScheduleListResult: object
interface

An interface representing the CloudJobScheduleListResult.

summary

The result of listing the job schedules in an account.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "CloudJobScheduleListResult"

__@iterator

  • Iterator

    Returns IterableIterator<CloudJobSchedule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CloudJobSchedule>[]

      Additional items to add to the end of array1.

    Returns CloudJobSchedule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CloudJobSchedule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CloudJobSchedule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CloudJobSchedule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CloudJobSchedule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CloudJobSchedule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CloudJobSchedule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CloudJobSchedule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns CloudJobSchedule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CloudJobSchedule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CloudJobSchedule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CloudJobSchedule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CloudJobSchedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CloudJobSchedule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CloudJobSchedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CloudJobSchedule | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CloudJobSchedule

  • Parameters

    Returns CloudJobSchedule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns CloudJobSchedule

  • Parameters

    Returns CloudJobSchedule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CloudJobSchedule[]

shift

  • Removes the first element from an array and returns it.

    Returns CloudJobSchedule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CloudJobSchedule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CloudJobSchedule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CloudJobSchedule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CloudJobSchedule[]

      Elements to insert into the array in place of the deleted elements.

    Returns CloudJobSchedule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CloudJobSchedule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<CloudJobSchedule>

type

type: object

className

className: string = "CloudJobScheduleListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CloudJobSchedule"

name

name: "Composite" = "Composite"

Const CloudPool

CloudPool: object

An interface representing CloudPool.

summary

A pool in the Azure Batch service.

Optional allocationState

allocationState: AllocationState

Whether the pool is resizing. Possible values include: 'steady', 'resizing', 'stopping'

Optional allocationStateTransitionTime

allocationStateTransitionTime: Date

The time at which the pool entered its current allocation state.

Optional applicationLicenses

applicationLicenses: string[]

The list of application licenses the Batch service will make available on each compute node in the pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

Optional applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

The list of application packages to be installed on each compute node in the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

Optional autoScaleEvaluationInterval

autoScaleEvaluationInterval: undefined | string

The time interval at which to automatically adjust the pool size according to the autoscale formula. This property is set only if the pool automatically scales, i.e. enableAutoScale is true.

Optional autoScaleFormula

autoScaleFormula: undefined | string

A formula for the desired number of compute nodes in the pool. This property is set only if the pool automatically scales, i.e. enableAutoScale is true.

Optional autoScaleRun

autoScaleRun: AutoScaleRun

The results and errors from the last execution of the autoscale formula. This property is set only if the pool automatically scales, i.e. enableAutoScale is true.

Optional certificateReferences

certificateReferences: CertificateReference[]

The list of certificates to be installed on each compute node in the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

Optional cloudServiceConfiguration

cloudServiceConfiguration: CloudServiceConfiguration

The cloud service configuration for the pool. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

Optional creationTime

creationTime: Date

The creation time of the pool.

Optional currentDedicatedNodes

currentDedicatedNodes: undefined | number

The number of dedicated compute nodes currently in the pool.

Optional currentLowPriorityNodes

currentLowPriorityNodes: undefined | number

The number of low-priority compute nodes currently in the pool. Low-priority compute nodes which have been preempted are included in this count.

Optional displayName

displayName: undefined | string

The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Optional eTag

eTag: undefined | string

The ETag of the pool. This is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime.

Optional enableAutoScale

enableAutoScale: undefined | false | true

Whether the pool size should automatically adjust over time. If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.

Optional enableInterNodeCommunication

enableInterNodeCommunication: undefined | false | true

Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool.

Optional id

id: undefined | string

A string that uniquely identifies the pool within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

Optional lastModified

lastModified: Date

The last modified time of the pool. This is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state.

Optional maxTasksPerNode

maxTasksPerNode: undefined | number

The maximum number of tasks that can run concurrently on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the pool as metadata.

Optional networkConfiguration

networkConfiguration: NetworkConfiguration

The network configuration for the pool.

Optional resizeErrors

resizeErrors: ResizeError[]

A list of errors encountered while performing the last resize on the pool. This property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady.

Optional resizeTimeout

resizeTimeout: undefined | string

The timeout for allocation of compute nodes to the pool. This is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes.

Optional startTask

startTask: StartTask

A task specified to run on each compute node as it joins the pool.

Optional state

state: PoolState

The current state of the pool. Possible values include: 'active', 'deleting'

Optional stateTransitionTime

stateTransitionTime: Date

The time at which the pool entered its current state.

Optional stats

Utilization and resource usage statistics for the entire lifetime of the pool. This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Optional targetDedicatedNodes

targetDedicatedNodes: undefined | number

The desired number of dedicated compute nodes in the pool.

Optional targetLowPriorityNodes

targetLowPriorityNodes: undefined | number

The desired number of low-priority compute nodes in the pool.

Optional taskSchedulingPolicy

taskSchedulingPolicy: TaskSchedulingPolicy

How tasks are distributed across compute nodes in a pool. If not specified, the default is spread.

Optional url

url: undefined | string

The URL of the pool.

Optional userAccounts

userAccounts: UserAccount[]

The list of user accounts to be created on each node in the pool.

Optional virtualMachineConfiguration

virtualMachineConfiguration: VirtualMachineConfiguration

The virtual machine configuration for the pool. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

Optional vmSize

vmSize: undefined | string

The size of virtual machines in the pool. All virtual machines in a pool are the same size. For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

serializedName

serializedName: string = "CloudPool"

type

type: object

className

className: string = "CloudPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allocationState

allocationState: object

serializedName

serializedName: string = "allocationState"

type

type: object

allowedValues

allowedValues: string[] = ["steady","resizing","stopping"]

name

name: "Enum" = "Enum"

allocationStateTransitionTime

allocationStateTransitionTime: object

serializedName

serializedName: string = "allocationStateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

applicationLicenses

applicationLicenses: object

serializedName

serializedName: string = "applicationLicenses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

applicationPackageReferences

applicationPackageReferences: object

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

autoScaleEvaluationInterval

autoScaleEvaluationInterval: object

serializedName

serializedName: string = "autoScaleEvaluationInterval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

autoScaleFormula

autoScaleFormula: object

serializedName

serializedName: string = "autoScaleFormula"

type

type: object

name

name: "String" = "String"

autoScaleRun

autoScaleRun: object

serializedName

serializedName: string = "autoScaleRun"

type

type: object

className

className: string = "AutoScaleRun"

name

name: "Composite" = "Composite"

certificateReferences

certificateReferences: object

serializedName

serializedName: string = "certificateReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateReference"

name

name: "Composite" = "Composite"

cloudServiceConfiguration

cloudServiceConfiguration: object

serializedName

serializedName: string = "cloudServiceConfiguration"

type

type: object

className

className: string = "CloudServiceConfiguration"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

currentDedicatedNodes

currentDedicatedNodes: object

serializedName

serializedName: string = "currentDedicatedNodes"

type

type: object

name

name: "Number" = "Number"

currentLowPriorityNodes

currentLowPriorityNodes: object

serializedName

serializedName: string = "currentLowPriorityNodes"

type

type: object

name

name: "Number" = "Number"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "eTag"

type

type: object

name

name: "String" = "String"

enableAutoScale

enableAutoScale: object

serializedName

serializedName: string = "enableAutoScale"

type

type: object

name

name: "Boolean" = "Boolean"

enableInterNodeCommunication

enableInterNodeCommunication: object

serializedName

serializedName: string = "enableInterNodeCommunication"

type

type: object

name

name: "Boolean" = "Boolean"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

maxTasksPerNode

maxTasksPerNode: object

serializedName

serializedName: string = "maxTasksPerNode"

type

type: object

name

name: "Number" = "Number"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

networkConfiguration

networkConfiguration: object

serializedName

serializedName: string = "networkConfiguration"

type

type: object

className

className: string = "NetworkConfiguration"

name

name: "Composite" = "Composite"

resizeErrors

resizeErrors: object

serializedName

serializedName: string = "resizeErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResizeError"

name

name: "Composite" = "Composite"

resizeTimeout

resizeTimeout: object

serializedName

serializedName: string = "resizeTimeout"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

startTask

startTask: object

serializedName

serializedName: string = "startTask"

type

type: object

className

className: string = "StartTask"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["active","deleting"]

name

name: "Enum" = "Enum"

stateTransitionTime

stateTransitionTime: object

serializedName

serializedName: string = "stateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

stats

stats: object

serializedName

serializedName: string = "stats"

type

type: object

className

className: string = "PoolStatistics"

name

name: "Composite" = "Composite"

targetDedicatedNodes

targetDedicatedNodes: object

serializedName

serializedName: string = "targetDedicatedNodes"

type

type: object

name

name: "Number" = "Number"

targetLowPriorityNodes

targetLowPriorityNodes: object

serializedName

serializedName: string = "targetLowPriorityNodes"

type

type: object

name

name: "Number" = "Number"

taskSchedulingPolicy

taskSchedulingPolicy: object

serializedName

serializedName: string = "taskSchedulingPolicy"

type

type: object

className

className: string = "TaskSchedulingPolicy"

name

name: "Composite" = "Composite"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

userAccounts

userAccounts: object

serializedName

serializedName: string = "userAccounts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserAccount"

name

name: "Composite" = "Composite"

virtualMachineConfiguration

virtualMachineConfiguration: object

serializedName

serializedName: string = "virtualMachineConfiguration"

type

type: object

className

className: string = "VirtualMachineConfiguration"

name

name: "Composite" = "Composite"

vmSize

vmSize: object

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const CloudPoolListResult

CloudPoolListResult: object
interface

An interface representing the CloudPoolListResult.

summary

The result of listing the pools in an account.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "CloudPoolListResult"

__@iterator

  • Iterator

    Returns IterableIterator<CloudPool>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CloudPool>[]

      Additional items to add to the end of array1.

    Returns CloudPool[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CloudPool[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, CloudPool]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CloudPool]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CloudPool, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CloudPool

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CloudPool[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CloudPool[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CloudPool | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns CloudPool | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CloudPool, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CloudPool

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CloudPool, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CloudPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CloudPool, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CloudPool

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CloudPool | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CloudPool[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): CloudPool
  • reduce(callbackfn: function, initialValue: CloudPool): CloudPool
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns CloudPool

  • Parameters

    Returns CloudPool

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudPool, currentIndex: number, array: CloudPool[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): CloudPool
  • reduceRight(callbackfn: function, initialValue: CloudPool): CloudPool
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns CloudPool

  • Parameters

    Returns CloudPool

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudPool, currentIndex: number, array: CloudPool[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CloudPool[]

shift

  • Removes the first element from an array and returns it.

    Returns CloudPool | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CloudPool[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CloudPool[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): CloudPool[]
  • splice(start: number, deleteCount: number, ...items: CloudPool[]): CloudPool[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CloudPool[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CloudPool[]

      Elements to insert into the array in place of the deleted elements.

    Returns CloudPool[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CloudPool[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<CloudPool>

type

type: object

className

className: string = "CloudPoolListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CloudPool"

name

name: "Composite" = "Composite"

Const CloudServiceConfiguration

CloudServiceConfiguration: object

An interface representing CloudServiceConfiguration.

summary

The configuration for nodes in a pool based on the Azure Cloud Services platform.

osFamily

osFamily: string

The Azure Guest OS family to be installed on the virtual machines in the pool. Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

Optional osVersion

osVersion: undefined | string

The Azure Guest OS version to be installed on the virtual machines in the pool. The default value is * which specifies the latest operating system version for the specified OS family.

serializedName

serializedName: string = "CloudServiceConfiguration"

type

type: object

className

className: string = "CloudServiceConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

osFamily

osFamily: object

required

required: true = true

serializedName

serializedName: string = "osFamily"

type

type: object

name

name: "String" = "String"

osVersion

osVersion: object

serializedName

serializedName: string = "osVersion"

type

type: object

name

name: "String" = "String"

Const CloudTask

CloudTask: object

Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.

summary

An Azure Batch task.

Optional affinityInfo

affinityInfo: AffinityInformation

A locality hint that can be used by the Batch service to select a compute node on which to start the new task.

Optional applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

A list of application packages that the Batch service will deploy to the compute node before running the command line. Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails.

Optional authenticationTokenSettings

authenticationTokenSettings: AuthenticationTokenSettings

The settings for an authentication token that the task can use to perform Batch service operations. If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.

Optional commandLine

commandLine: undefined | string

The command line of the task. For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

Optional constraints

constraints: TaskConstraints

The execution constraints that apply to this task.

Optional containerSettings

containerSettings: TaskContainerSettings

The settings for the container under which the task runs. If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

Optional creationTime

creationTime: Date

The creation time of the task.

Optional dependsOn

dependsOn: TaskDependencies

The tasks that this task depends on. This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled.

Optional displayName

displayName: undefined | string

A display name for the task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Optional eTag

eTag: undefined | string

The ETag of the task. This is an opaque string. You can use it to detect whether the task has changed between requests. In particular, you can be pass the ETag when updating a task to specify that your changes should take effect only if nobody else has modified the task in the meantime.

Optional environmentSettings

environmentSettings: EnvironmentSetting[]

A list of environment variable settings for the task.

Optional executionInfo

Information about the execution of the task.

Optional exitConditions

exitConditions: ExitConditions

How the Batch service should respond when the task completes.

Optional id

id: undefined | string

A string that uniquely identifies the task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.

Optional lastModified

lastModified: Date

The last modified time of the task.

Optional multiInstanceSettings

multiInstanceSettings: MultiInstanceSettings

An object that indicates that the task is a multi-instance task, and contains information about how to run the multi-instance task.

Optional nodeInfo

Information about the compute node on which the task ran.

Optional outputFiles

outputFiles: OutputFile[]

A list of files that the Batch service will upload from the compute node after running the command line. For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.

Optional previousState

previousState: TaskState

The previous state of the task. This property is not set if the task is in its initial Active state. Possible values include: 'active', 'preparing', 'running', 'completed'

Optional previousStateTransitionTime

previousStateTransitionTime: Date

The time at which the task entered its previous state. This property is not set if the task is in its initial Active state.

Optional resourceFiles

resourceFiles: ResourceFile[]

A list of files that the Batch service will download to the compute node before running the command line. For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

Optional state

state: TaskState

The current state of the task. Possible values include: 'active', 'preparing', 'running', 'completed'

Optional stateTransitionTime

stateTransitionTime: Date

The time at which the task entered its current state.

Optional stats

Resource usage statistics for the task.

Optional url

url: undefined | string

The URL of the task.

Optional userIdentity

userIdentity: UserIdentity

The user identity under which the task runs. If omitted, the task runs as a non-administrative user unique to the task.

serializedName

serializedName: string = "CloudTask"

type

type: object

className

className: string = "CloudTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affinityInfo

affinityInfo: object

serializedName

serializedName: string = "affinityInfo"

type

type: object

className

className: string = "AffinityInformation"

name

name: "Composite" = "Composite"

applicationPackageReferences

applicationPackageReferences: object

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

authenticationTokenSettings

authenticationTokenSettings: object

serializedName

serializedName: string = "authenticationTokenSettings"

type

type: object

className

className: string = "AuthenticationTokenSettings"

name

name: "Composite" = "Composite"

commandLine

commandLine: object

serializedName

serializedName: string = "commandLine"

type

type: object

name

name: "String" = "String"

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "TaskConstraints"

name

name: "Composite" = "Composite"

containerSettings

containerSettings: object

serializedName

serializedName: string = "containerSettings"

type

type: object

className

className: string = "TaskContainerSettings"

name

name: "Composite" = "Composite"

creationTime

creationTime: object

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

dependsOn

dependsOn: object

serializedName

serializedName: string = "dependsOn"

type

type: object

className

className: string = "TaskDependencies"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "eTag"

type

type: object

name

name: "String" = "String"

environmentSettings

environmentSettings: object

serializedName

serializedName: string = "environmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

executionInfo

executionInfo: object

serializedName

serializedName: string = "executionInfo"

type

type: object

className

className: string = "TaskExecutionInformation"

name

name: "Composite" = "Composite"

exitConditions

exitConditions: object

serializedName

serializedName: string = "exitConditions"

type

type: object

className

className: string = "ExitConditions"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

multiInstanceSettings

multiInstanceSettings: object

serializedName

serializedName: string = "multiInstanceSettings"

type

type: object

className

className: string = "MultiInstanceSettings"

name

name: "Composite" = "Composite"

nodeInfo

nodeInfo: object

serializedName

serializedName: string = "nodeInfo"

type

type: object

className

className: string = "ComputeNodeInformation"

name

name: "Composite" = "Composite"

outputFiles

outputFiles: object

serializedName

serializedName: string = "outputFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OutputFile"

name

name: "Composite" = "Composite"

previousState

previousState: object

serializedName

serializedName: string = "previousState"

type

type: object

allowedValues

allowedValues: string[] = ["active","preparing","running","completed"]

name

name: "Enum" = "Enum"

previousStateTransitionTime

previousStateTransitionTime: object

serializedName

serializedName: string = "previousStateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

resourceFiles

resourceFiles: object

serializedName

serializedName: string = "resourceFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["active","preparing","running","completed"]

name

name: "Enum" = "Enum"

stateTransitionTime

stateTransitionTime: object

serializedName

serializedName: string = "stateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

stats

stats: object

serializedName

serializedName: string = "stats"

type

type: object

className

className: string = "TaskStatistics"

name

name: "Composite" = "Composite"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

userIdentity

userIdentity: object

serializedName

serializedName: string = "userIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

Const CloudTaskListResult

CloudTaskListResult: object
interface

An interface representing the CloudTaskListResult.

summary

The result of listing the tasks in a job.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "CloudTaskListResult"

__@iterator

  • Iterator

    Returns IterableIterator<CloudTask>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CloudTask>[]

      Additional items to add to the end of array1.

    Returns CloudTask[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CloudTask[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, CloudTask]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CloudTask]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CloudTask, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CloudTask

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CloudTask[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CloudTask[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CloudTask | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns CloudTask | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CloudTask, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CloudTask

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CloudTask, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CloudTask

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CloudTask, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CloudTask

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CloudTask | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CloudTask[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): CloudTask
  • reduce(callbackfn: function, initialValue: CloudTask): CloudTask
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns CloudTask

  • Parameters

    Returns CloudTask

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudTask, currentIndex: number, array: CloudTask[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): CloudTask
  • reduceRight(callbackfn: function, initialValue: CloudTask): CloudTask
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns CloudTask

  • Parameters

    Returns CloudTask

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudTask, currentIndex: number, array: CloudTask[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CloudTask[]

shift

  • Removes the first element from an array and returns it.

    Returns CloudTask | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CloudTask[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CloudTask[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): CloudTask[]
  • splice(start: number, deleteCount: number, ...items: CloudTask[]): CloudTask[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CloudTask[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CloudTask[]

      Elements to insert into the array in place of the deleted elements.

    Returns CloudTask[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CloudTask[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<CloudTask>

type

type: object

className

className: string = "CloudTaskListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CloudTask"

name

name: "Composite" = "Composite"

Const CloudTaskListSubtasksResult

CloudTaskListSubtasksResult: object

An interface representing CloudTaskListSubtasksResult.

summary

The result of listing the subtasks of a task.

Optional value

The list of subtasks.

serializedName

serializedName: string = "CloudTaskListSubtasksResult"

type

type: object

className

className: string = "CloudTaskListSubtasksResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubtaskInformation"

name

name: "Composite" = "Composite"

Const ComputeNode

ComputeNode: object

An interface representing ComputeNode.

summary

A compute node in the Batch service.

Optional affinityId

affinityId: undefined | string

An identifier which can be passed when adding a task to request that the task be scheduled on this node. Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere.

Optional allocationTime

allocationTime: Date

The time at which this compute node was allocated to the pool. This is the time when the node was initially allocated and doesn't change once set. It is not updated when the node is service healed or preempted.

Optional certificateReferences

certificateReferences: CertificateReference[]

The list of certificates installed on the compute node. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

Optional endpointConfiguration

endpointConfiguration: ComputeNodeEndpointConfiguration

The endpoint configuration for the compute node.

Optional errors

The list of errors that are currently being encountered by the compute node.

Optional id

id: undefined | string

The ID of the compute node. Every node that is added to a pool is assigned a unique ID. Whenever a node is removed from a pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new nodes.

Optional ipAddress

ipAddress: undefined | string

The IP address that other compute nodes can use to communicate with this compute node. Every node that is added to a pool is assigned a unique IP address. Whenever a node is removed from a pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new nodes.

Optional isDedicated

isDedicated: undefined | false | true

Whether this compute node is a dedicated node. If false, the node is a low-priority node.

Optional lastBootTime

lastBootTime: Date

The last time at which the compute node was started. This property may not be present if the node state is unusable.

Optional nodeAgentInfo

nodeAgentInfo: NodeAgentInformation

Information about the node agent version and the time the node upgraded to a new version.

Optional recentTasks

recentTasks: TaskInformation[]

A list of tasks whose state has recently changed. This property is present only if at least one task has run on this node since it was assigned to the pool.

Optional runningTasksCount

runningTasksCount: undefined | number

The total number of currently running job tasks on the compute node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks.

Optional schedulingState

schedulingState: SchedulingState

Whether the compute node is available for task scheduling. Possible values include: 'enabled', 'disabled'

Optional startTask

startTask: StartTask

The task specified to run on the compute node as it joins the pool.

Optional startTaskInfo

startTaskInfo: StartTaskInformation

Runtime information about the execution of the start task on the compute node.

Optional state

The current state of the compute node. The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available. Possible values include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', 'creating', 'starting', 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', 'offline', 'preempted'

Optional stateTransitionTime

stateTransitionTime: Date

The time at which the compute node entered its current state.

Optional totalTasksRun

totalTasksRun: undefined | number

The total number of job tasks completed on the compute node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks.

Optional totalTasksSucceeded

totalTasksSucceeded: undefined | number

The total number of job tasks which completed successfully (with exitCode 0) on the compute node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks.

Optional url

url: undefined | string

The URL of the compute node.

Optional vmSize

vmSize: undefined | string

The size of the virtual machine hosting the compute node. For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

serializedName

serializedName: string = "ComputeNode"

type

type: object

className

className: string = "ComputeNode"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affinityId

affinityId: object

serializedName

serializedName: string = "affinityId"

type

type: object

name

name: "String" = "String"

allocationTime

allocationTime: object

serializedName

serializedName: string = "allocationTime"

type

type: object

name

name: "DateTime" = "DateTime"

certificateReferences

certificateReferences: object

serializedName

serializedName: string = "certificateReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateReference"

name

name: "Composite" = "Composite"

endpointConfiguration

endpointConfiguration: object

serializedName

serializedName: string = "endpointConfiguration"

type

type: object

className

className: string = "ComputeNodeEndpointConfiguration"

name

name: "Composite" = "Composite"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeNodeError"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

isDedicated

isDedicated: object

serializedName

serializedName: string = "isDedicated"

type

type: object

name

name: "Boolean" = "Boolean"

lastBootTime

lastBootTime: object

serializedName

serializedName: string = "lastBootTime"

type

type: object

name

name: "DateTime" = "DateTime"

nodeAgentInfo

nodeAgentInfo: object

serializedName

serializedName: string = "nodeAgentInfo"

type

type: object

className

className: string = "NodeAgentInformation"

name

name: "Composite" = "Composite"

recentTasks

recentTasks: object

serializedName

serializedName: string = "recentTasks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TaskInformation"

name

name: "Composite" = "Composite"

runningTasksCount

runningTasksCount: object

serializedName

serializedName: string = "runningTasksCount"

type

type: object

name

name: "Number" = "Number"

schedulingState

schedulingState: object

serializedName

serializedName: string = "schedulingState"

type

type: object

allowedValues

allowedValues: string[] = ["enabled","disabled"]

name

name: "Enum" = "Enum"

startTask

startTask: object

serializedName

serializedName: string = "startTask"

type

type: object

className

className: string = "StartTask"

name

name: "Composite" = "Composite"

startTaskInfo

startTaskInfo: object

serializedName

serializedName: string = "startTaskInfo"

type

type: object

className

className: string = "StartTaskInformation"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["idle","rebooting","reimaging","running","unusable","creating","starting","waitingforstarttask","starttaskfailed","unknown","leavingpool","offline","preempted"]

name

name: "Enum" = "Enum"

stateTransitionTime

stateTransitionTime: object

serializedName

serializedName: string = "stateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

totalTasksRun

totalTasksRun: object

serializedName

serializedName: string = "totalTasksRun"

type

type: object

name

name: "Number" = "Number"

totalTasksSucceeded

totalTasksSucceeded: object

serializedName

serializedName: string = "totalTasksSucceeded"

type

type: object

name

name: "Number" = "Number"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

vmSize

vmSize: object

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const ComputeNodeAddUserHeaders

ComputeNodeAddUserHeaders: object

Defines headers for AddUser operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-adduser-headers"

type

type: object

className

className: string = "ComputeNodeAddUserHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeAddUserOptions

ComputeNodeAddUserOptions: object

Additional parameters for addUser operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeAddUserOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeDeleteUserHeaders

ComputeNodeDeleteUserHeaders: object

Defines headers for DeleteUser operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-deleteuser-headers"

type

type: object

className

className: string = "ComputeNodeDeleteUserHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const ComputeNodeDeleteUserOptions

ComputeNodeDeleteUserOptions: object

Additional parameters for deleteUser operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeDeleteUserOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeDisableSchedulingHeaders

ComputeNodeDisableSchedulingHeaders: object

Defines headers for DisableScheduling operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-disablescheduling-headers"

type

type: object

className

className: string = "ComputeNodeDisableSchedulingHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeDisableSchedulingOptions

ComputeNodeDisableSchedulingOptions: object

Additional parameters for disableScheduling operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeDisableSchedulingOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeEnableSchedulingHeaders

ComputeNodeEnableSchedulingHeaders: object

Defines headers for EnableScheduling operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-enablescheduling-headers"

type

type: object

className

className: string = "ComputeNodeEnableSchedulingHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeEnableSchedulingOptions

ComputeNodeEnableSchedulingOptions: object

Additional parameters for enableScheduling operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeEnableSchedulingOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeEndpointConfiguration

ComputeNodeEndpointConfiguration: object

An interface representing ComputeNodeEndpointConfiguration.

summary

The endpoint configuration for the compute node.

inboundEndpoints

inboundEndpoints: InboundEndpoint[]

The list of inbound endpoints that are accessible on the compute node.

serializedName

serializedName: string = "ComputeNodeEndpointConfiguration"

type

type: object

className

className: string = "ComputeNodeEndpointConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inboundEndpoints

inboundEndpoints: object

required

required: true = true

serializedName

serializedName: string = "inboundEndpoints"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundEndpoint"

name

name: "Composite" = "Composite"

Const ComputeNodeError

ComputeNodeError: object

An interface representing ComputeNodeError.

summary

An error encountered by a compute node.

Optional code

code: undefined | string

An identifier for the compute node error. Codes are invariant and are intended to be consumed programmatically.

Optional errorDetails

errorDetails: NameValuePair[]

The list of additional error details related to the compute node error.

Optional message

message: undefined | string

A message describing the compute node error, intended to be suitable for display in a user interface.

serializedName

serializedName: string = "ComputeNodeError"

type

type: object

className

className: string = "ComputeNodeError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const ComputeNodeGetHeaders

ComputeNodeGetHeaders: object

Defines headers for Get operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-get-headers"

type

type: object

className

className: string = "ComputeNodeGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeGetOptions

ComputeNodeGetOptions: object

Additional parameters for get operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeGetOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeGetRemoteDesktopHeaders

ComputeNodeGetRemoteDesktopHeaders: object

Defines headers for GetRemoteDesktop operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-getremotedesktop-headers"

type

type: object

className

className: string = "ComputeNodeGetRemoteDesktopHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeGetRemoteDesktopOptions

ComputeNodeGetRemoteDesktopOptions: object

Additional parameters for getRemoteDesktop operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeGetRemoteDesktopOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeGetRemoteLoginSettingsHeaders

ComputeNodeGetRemoteLoginSettingsHeaders: object

Defines headers for GetRemoteLoginSettings operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-getremoteloginsettings-headers"

type

type: object

className

className: string = "ComputeNodeGetRemoteLoginSettingsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeGetRemoteLoginSettingsOptions

ComputeNodeGetRemoteLoginSettingsOptions: object

Additional parameters for getRemoteLoginSettings operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeGetRemoteLoginSettingsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeGetRemoteLoginSettingsResult

ComputeNodeGetRemoteLoginSettingsResult: object

An interface representing ComputeNodeGetRemoteLoginSettingsResult.

summary

The remote login settings for a compute node.

remoteLoginIPAddress

remoteLoginIPAddress: string

The IP address used for remote login to the compute node.

remoteLoginPort

remoteLoginPort: number

The port used for remote login to the compute node.

serializedName

serializedName: string = "ComputeNodeGetRemoteLoginSettingsResult"

type

type: object

className

className: string = "ComputeNodeGetRemoteLoginSettingsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

remoteLoginIPAddress

remoteLoginIPAddress: object

required

required: true = true

serializedName

serializedName: string = "remoteLoginIPAddress"

type

type: object

name

name: "String" = "String"

remoteLoginPort

remoteLoginPort: object

required

required: true = true

serializedName

serializedName: string = "remoteLoginPort"

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeInformation

ComputeNodeInformation: object

An interface representing ComputeNodeInformation.

summary

Information about the compute node on which a task ran.

Optional affinityId

affinityId: undefined | string

An identifier for the compute node on which the task ran, which can be passed when adding a task to request that the task be scheduled on this compute node.

Optional nodeId

nodeId: undefined | string

The ID of the node on which the task ran.

Optional nodeUrl

nodeUrl: undefined | string

The URL of the node on which the task ran. .

Optional poolId

poolId: undefined | string

The ID of the pool on which the task ran.

Optional taskRootDirectory

taskRootDirectory: undefined | string

The root directory of the task on the compute node.

Optional taskRootDirectoryUrl

taskRootDirectoryUrl: undefined | string

The URL to the root directory of the task on the compute node.

serializedName

serializedName: string = "ComputeNodeInformation"

type

type: object

className

className: string = "ComputeNodeInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affinityId

affinityId: object

serializedName

serializedName: string = "affinityId"

type

type: object

name

name: "String" = "String"

nodeId

nodeId: object

serializedName

serializedName: string = "nodeId"

type

type: object

name

name: "String" = "String"

nodeUrl

nodeUrl: object

serializedName

serializedName: string = "nodeUrl"

type

type: object

name

name: "String" = "String"

poolId

poolId: object

serializedName

serializedName: string = "poolId"

type

type: object

name

name: "String" = "String"

taskRootDirectory

taskRootDirectory: object

serializedName

serializedName: string = "taskRootDirectory"

type

type: object

name

name: "String" = "String"

taskRootDirectoryUrl

taskRootDirectoryUrl: object

serializedName

serializedName: string = "taskRootDirectoryUrl"

type

type: object

name

name: "String" = "String"

Const ComputeNodeListHeaders

ComputeNodeListHeaders: object

Defines headers for List operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-list-headers"

type

type: object

className

className: string = "ComputeNodeListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeListNextOptions

ComputeNodeListNextOptions: object

Additional parameters for listNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "ComputeNodeListNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const ComputeNodeListOptions

ComputeNodeListOptions: object

Additional parameters for list operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 nodes can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeListOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeListResult

ComputeNodeListResult: object
interface

An interface representing the ComputeNodeListResult.

summary

The result of listing the compute nodes in a pool.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "ComputeNodeListResult"

__@iterator

  • Iterator

    Returns IterableIterator<ComputeNode>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ComputeNode>[]

      Additional items to add to the end of array1.

    Returns ComputeNode[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ComputeNode[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ComputeNode]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ComputeNode, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ComputeNode

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ComputeNode[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ComputeNode[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ComputeNode | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ComputeNode | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ComputeNode, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ComputeNode

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ComputeNode, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ComputeNode

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ComputeNode, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ComputeNode

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ComputeNode | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ComputeNode[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ComputeNode

  • Parameters

    Returns ComputeNode

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ComputeNode
  • reduceRight(callbackfn: function, initialValue: ComputeNode): ComputeNode
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ComputeNode

  • Parameters

    Returns ComputeNode

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ComputeNode[]

shift

  • Removes the first element from an array and returns it.

    Returns ComputeNode | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ComputeNode[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ComputeNode[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ComputeNode[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ComputeNode[]

      Elements to insert into the array in place of the deleted elements.

    Returns ComputeNode[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ComputeNode[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ComputeNode>

type

type: object

className

className: string = "ComputeNodeListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ComputeNode"

name

name: "Composite" = "Composite"

Const ComputeNodeRebootHeaders

ComputeNodeRebootHeaders: object

Defines headers for Reboot operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-reboot-headers"

type

type: object

className

className: string = "ComputeNodeRebootHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeRebootOptions

ComputeNodeRebootOptions: object

Additional parameters for reboot operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeRebootOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeReimageHeaders

ComputeNodeReimageHeaders: object

Defines headers for Reimage operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-reimage-headers"

type

type: object

className

className: string = "ComputeNodeReimageHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeReimageOptions

ComputeNodeReimageOptions: object

Additional parameters for reimage operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeReimageOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeUpdateUserHeaders

ComputeNodeUpdateUserHeaders: object

Defines headers for UpdateUser operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-updateuser-headers"

type

type: object

className

className: string = "ComputeNodeUpdateUserHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeUpdateUserOptions

ComputeNodeUpdateUserOptions: object

Additional parameters for updateUser operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeUpdateUserOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeUploadBatchServiceLogsHeaders

ComputeNodeUploadBatchServiceLogsHeaders: object

Defines headers for UploadBatchServiceLogs operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "computenode-uploadbatchservicelogs-headers"

type

type: object

className

className: string = "ComputeNodeUploadBatchServiceLogsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const ComputeNodeUploadBatchServiceLogsOptions

ComputeNodeUploadBatchServiceLogsOptions: object

Additional parameters for uploadBatchServiceLogs operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "ComputeNodeUploadBatchServiceLogsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const ComputeNodeUser

ComputeNodeUser: object

An interface representing ComputeNodeUser.

summary

A user account for RDP or SSH access on a compute node.

Optional expiryTime

expiryTime: Date

The time at which the account should expire. If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day.

Optional isAdmin

isAdmin: undefined | false | true

Whether the account should be an administrator on the compute node. The default value is false.

name

name: string

The user name of the account.

Optional password

password: undefined | string

The password of the account. The password is required for Windows nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property.

Optional sshPublicKey

sshPublicKey: undefined | string

The SSH public key that can be used for remote login to the compute node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

serializedName

serializedName: string = "ComputeNodeUser"

type

type: object

className

className: string = "ComputeNodeUser"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryTime

expiryTime: object

serializedName

serializedName: string = "expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

isAdmin

isAdmin: object

serializedName

serializedName: string = "isAdmin"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

sshPublicKey

sshPublicKey: object

serializedName

serializedName: string = "sshPublicKey"

type

type: object

name

name: "String" = "String"

Const ContainerConfiguration

ContainerConfiguration: object

An interface representing ContainerConfiguration.

summary

The configuration for container-enabled pools.

Optional containerImageNames

containerImageNames: string[]

The collection of container image names. This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.

Optional containerRegistries

containerRegistries: ContainerRegistry[]

Additional private registries from which containers can be pulled. If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.

serializedName

serializedName: string = "ContainerConfiguration"

type

type: object

className

className: string = "ContainerConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerImageNames

containerImageNames: object

serializedName

serializedName: string = "containerImageNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

containerRegistries

containerRegistries: object

serializedName

serializedName: string = "containerRegistries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContainerRegistry"

name

name: "Composite" = "Composite"

type

type: object

defaultValue

defaultValue: string = "dockerCompatible"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ContainerRegistry

ContainerRegistry: object

An interface representing ContainerRegistry.

summary

A private container registry.

password

password: string

The password to log into the registry server.

Optional registryServer

registryServer: undefined | string

The registry URL. If omitted, the default is "docker.io".

userName

userName: string

The user name to log into the registry server.

serializedName

serializedName: string = "ContainerRegistry"

type

type: object

className

className: string = "ContainerRegistry"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

password

password: object

required

required: true = true

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

registryServer

registryServer: object

serializedName

serializedName: string = "registryServer"

type

type: object

name

name: "String" = "String"

userName

userName: object

required

required: true = true

serializedName

serializedName: string = "username"

type

type: object

name

name: "String" = "String"

Const DataDisk

DataDisk: object

An interface representing DataDisk.

summary

Settings which will be used by the data disks associated to compute nodes in the pool.

Optional caching

caching: CachingType

The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Possible values include: 'none', 'readOnly', 'readWrite'

diskSizeGB

diskSizeGB: number

The initial disk size in gigabytes.

lun

lun: number

The logical unit number. The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.

Optional storageAccountType

storageAccountType: StorageAccountType

The storage account type to be used for the data disk. If omitted, the default is "standard_lrs". Possible values include: 'StandardLRS', 'PremiumLRS'

serializedName

serializedName: string = "DataDisk"

type

type: object

className

className: string = "DataDisk"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

caching

caching: object

serializedName

serializedName: string = "caching"

type

type: object

allowedValues

allowedValues: string[] = ["none","readonly","readwrite"]

name

name: "Enum" = "Enum"

diskSizeGB

diskSizeGB: object

required

required: true = true

serializedName

serializedName: string = "diskSizeGB"

type

type: object

name

name: "Number" = "Number"

lun

lun: object

required

required: true = true

serializedName

serializedName: string = "lun"

type

type: object

name

name: "Number" = "Number"

storageAccountType

storageAccountType: object

serializedName

serializedName: string = "storageAccountType"

type

type: object

allowedValues

allowedValues: string[] = ["standard_lrs","premium_lrs"]

name

name: "Enum" = "Enum"

Const DeleteCertificateError

DeleteCertificateError: object

An interface representing DeleteCertificateError.

summary

An error encountered by the Batch service when deleting a certificate.

Optional code

code: undefined | string

An identifier for the certificate deletion error. Codes are invariant and are intended to be consumed programmatically.

Optional message

message: undefined | string

A message describing the certificate deletion error, intended to be suitable for display in a user interface.

Optional values

values: NameValuePair[]

A list of additional error details related to the certificate deletion error. This list includes details such as the active pools and nodes referencing this certificate. However, if a large number of resources reference the certificate, the list contains only about the first hundred.

serializedName

serializedName: string = "DeleteCertificateError"

type

type: object

className

className: string = "DeleteCertificateError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

Const EnvironmentSetting

EnvironmentSetting: object

An interface representing EnvironmentSetting.

summary

An environment variable to be set on a task process.

name

name: string

The name of the environment variable.

Optional value

value: undefined | string

The value of the environment variable.

serializedName

serializedName: string = "EnvironmentSetting"

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ErrorMessage

ErrorMessage: object

An interface representing ErrorMessage.

summary

An error message received in an Azure Batch error response.

Optional lang

lang: undefined | string

The language code of the error message.

Optional value

value: undefined | string

The text of the message.

serializedName

serializedName: string = "ErrorMessage"

type

type: object

className

className: string = "ErrorMessage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lang

lang: object

serializedName

serializedName: string = "lang"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ExitCodeMapping

ExitCodeMapping: object

An interface representing ExitCodeMapping.

summary

How the Batch service should respond if a task exits with a particular exit code.

code

code: number

A process exit code.

exitOptions

exitOptions: ExitOptions

How the Batch service should respond if the task exits with this exit code.

serializedName

serializedName: string = "ExitCodeMapping"

type

type: object

className

className: string = "ExitCodeMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "Number" = "Number"

exitOptions

exitOptions: object

required

required: true = true

serializedName

serializedName: string = "exitOptions"

type

type: object

className

className: string = "ExitOptions"

name

name: "Composite" = "Composite"

Const ExitCodeRangeMapping

ExitCodeRangeMapping: object

An interface representing ExitCodeRangeMapping.

summary

A range of exit codes and how the Batch service should respond to exit codes within that range.

end

end: number

The last exit code in the range.

exitOptions

exitOptions: ExitOptions

How the Batch service should respond if the task exits with an exit code in the range start to end (inclusive).

start

start: number

The first exit code in the range.

serializedName

serializedName: string = "ExitCodeRangeMapping"

type

type: object

className

className: string = "ExitCodeRangeMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

end

end: object

required

required: true = true

serializedName

serializedName: string = "end"

type

type: object

name

name: "Number" = "Number"

exitOptions

exitOptions: object

required

required: true = true

serializedName

serializedName: string = "exitOptions"

type

type: object

className

className: string = "ExitOptions"

name

name: "Composite" = "Composite"

start

start: object

required

required: true = true

serializedName

serializedName: string = "start"

type

type: object

name

name: "Number" = "Number"

Const ExitConditions

ExitConditions: object

An interface representing ExitConditions.

summary

Specifies how the Batch service should respond when the task completes.

Optional default

default: ExitOptions

How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties. This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.

Optional exitCodeRanges

exitCodeRanges: ExitCodeRangeMapping[]

A list of task exit code ranges and how the Batch service should respond to them.

Optional exitCodes

exitCodes: ExitCodeMapping[]

A list of individual task exit codes and how the Batch service should respond to them.

Optional fileUploadError

fileUploadError: ExitOptions

How the Batch service should respond if a file upload error occurs. If the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.

Optional preProcessingError

preProcessingError: ExitOptions

How the Batch service should respond if the task fails to start due to an error.

serializedName

serializedName: string = "ExitConditions"

type

type: object

className

className: string = "ExitConditions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

default

default: object

serializedName

serializedName: string = "default"

type

type: object

className

className: string = "ExitOptions"

name

name: "Composite" = "Composite"

exitCodeRanges

exitCodeRanges: object

serializedName

serializedName: string = "exitCodeRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExitCodeRangeMapping"

name

name: "Composite" = "Composite"

exitCodes

exitCodes: object

serializedName

serializedName: string = "exitCodes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExitCodeMapping"

name

name: "Composite" = "Composite"

fileUploadError

fileUploadError: object

serializedName

serializedName: string = "fileUploadError"

type

type: object

className

className: string = "ExitOptions"

name

name: "Composite" = "Composite"

preProcessingError

preProcessingError: object

serializedName

serializedName: string = "preProcessingError"

type

type: object

className

className: string = "ExitOptions"

name

name: "Composite" = "Composite"

Const ExitOptions

ExitOptions: object

An interface representing ExitOptions.

summary

Specifies how the Batch service responds to a particular exit condition.

Optional dependencyAction

dependencyAction: DependencyAction

An action that the Batch service performs on tasks that depend on this task. The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'satisfy', 'block'

Optional jobAction

jobAction: JobAction

An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'. The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'none', 'disable', 'terminate'

serializedName

serializedName: string = "ExitOptions"

type

type: object

className

className: string = "ExitOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dependencyAction

dependencyAction: object

serializedName

serializedName: string = "dependencyAction"

type

type: object

allowedValues

allowedValues: string[] = ["satisfy","block"]

name

name: "Enum" = "Enum"

jobAction

jobAction: object

serializedName

serializedName: string = "jobAction"

type

type: object

allowedValues

allowedValues: string[] = ["none","disable","terminate"]

name

name: "Enum" = "Enum"

Const FileDeleteFromComputeNodeHeaders

FileDeleteFromComputeNodeHeaders: object

Defines headers for DeleteFromComputeNode operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-deletefromcomputenode-headers"

type

type: object

className

className: string = "FileDeleteFromComputeNodeHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const FileDeleteFromComputeNodeOptions

FileDeleteFromComputeNodeOptions: object

Additional parameters for deleteFromComputeNode operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileDeleteFromComputeNodeOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileDeleteFromTaskHeaders

FileDeleteFromTaskHeaders: object

Defines headers for DeleteFromTask operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-deletefromtask-headers"

type

type: object

className

className: string = "FileDeleteFromTaskHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const FileDeleteFromTaskOptions

FileDeleteFromTaskOptions: object

Additional parameters for deleteFromTask operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileDeleteFromTaskOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileGetFromComputeNodeHeaders

FileGetFromComputeNodeHeaders: object

Defines headers for GetFromComputeNode operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

contentLength

contentLength: number

The length of the file.

contentType

contentType: string

The content type of the file.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: boolean

Whether the object represents a directory.

ocpBatchFileMode

ocpBatchFileMode: string

The file mode attribute in octal format.

ocpBatchFileUrl

ocpBatchFileUrl: string

The URL of the file.

ocpCreationTime

ocpCreationTime: Date

The file creation time.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-getfromcomputenode-headers"

type

type: object

className

className: string = "FileGetFromComputeNodeHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: object

serializedName

serializedName: string = "ocp-batch-file-isdirectory"

type

type: object

name

name: "Boolean" = "Boolean"

ocpBatchFileMode

ocpBatchFileMode: object

serializedName

serializedName: string = "ocp-batch-file-mode"

type

type: object

name

name: "String" = "String"

ocpBatchFileUrl

ocpBatchFileUrl: object

serializedName

serializedName: string = "ocp-batch-file-url"

type

type: object

name

name: "String" = "String"

ocpCreationTime

ocpCreationTime: object

serializedName

serializedName: string = "ocp-creation-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const FileGetFromComputeNodeOptions

FileGetFromComputeNodeOptions: object

Additional parameters for getFromComputeNode operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional ocpRange

ocpRange: undefined | string

The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileGetFromComputeNodeOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpRange

ocpRange: object

type

type: object

name

name: "String" = "String"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileGetFromTaskHeaders

FileGetFromTaskHeaders: object

Defines headers for GetFromTask operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

contentLength

contentLength: number

The length of the file.

contentType

contentType: string

The content type of the file.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: boolean

Whether the object represents a directory.

ocpBatchFileMode

ocpBatchFileMode: string

The file mode attribute in octal format.

ocpBatchFileUrl

ocpBatchFileUrl: string

The URL of the file.

ocpCreationTime

ocpCreationTime: Date

The file creation time.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-getfromtask-headers"

type

type: object

className

className: string = "FileGetFromTaskHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: object

serializedName

serializedName: string = "ocp-batch-file-isdirectory"

type

type: object

name

name: "Boolean" = "Boolean"

ocpBatchFileMode

ocpBatchFileMode: object

serializedName

serializedName: string = "ocp-batch-file-mode"

type

type: object

name

name: "String" = "String"

ocpBatchFileUrl

ocpBatchFileUrl: object

serializedName

serializedName: string = "ocp-batch-file-url"

type

type: object

name

name: "String" = "String"

ocpCreationTime

ocpCreationTime: object

serializedName

serializedName: string = "ocp-creation-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const FileGetFromTaskOptions

FileGetFromTaskOptions: object

Additional parameters for getFromTask operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional ocpRange

ocpRange: undefined | string

The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileGetFromTaskOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpRange

ocpRange: object

type

type: object

name

name: "String" = "String"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileGetPropertiesFromComputeNodeHeaders

FileGetPropertiesFromComputeNodeHeaders: object

Defines headers for GetPropertiesFromComputeNode operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

contentLength

contentLength: number

The length of the file.

contentType

contentType: string

The content type of the file.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: boolean

Whether the object represents a directory.

ocpBatchFileMode

ocpBatchFileMode: string

The file mode attribute in octal format.

ocpBatchFileUrl

ocpBatchFileUrl: string

The URL of the file.

ocpCreationTime

ocpCreationTime: Date

The file creation time.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-getpropertiesfromcomputenode-headers"

type

type: object

className

className: string = "FileGetPropertiesFromComputeNodeHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: object

serializedName

serializedName: string = "ocp-batch-file-isdirectory"

type

type: object

name

name: "Boolean" = "Boolean"

ocpBatchFileMode

ocpBatchFileMode: object

serializedName

serializedName: string = "ocp-batch-file-mode"

type

type: object

name

name: "String" = "String"

ocpBatchFileUrl

ocpBatchFileUrl: object

serializedName

serializedName: string = "ocp-batch-file-url"

type

type: object

name

name: "String" = "String"

ocpCreationTime

ocpCreationTime: object

serializedName

serializedName: string = "ocp-creation-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const FileGetPropertiesFromComputeNodeOptions

FileGetPropertiesFromComputeNodeOptions: object

Additional parameters for getPropertiesFromComputeNode operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileGetPropertiesFromComputeNodeOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileGetPropertiesFromTaskHeaders

FileGetPropertiesFromTaskHeaders: object

Defines headers for GetPropertiesFromTask operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

contentLength

contentLength: number

The length of the file.

contentType

contentType: string

The content type of the file.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: boolean

Whether the object represents a directory.

ocpBatchFileMode

ocpBatchFileMode: string

The file mode attribute in octal format.

ocpBatchFileUrl

ocpBatchFileUrl: string

The URL of the file.

ocpCreationTime

ocpCreationTime: Date

The file creation time.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-getpropertiesfromtask-headers"

type

type: object

className

className: string = "FileGetPropertiesFromTaskHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

contentLength

contentLength: object

serializedName

serializedName: string = "content-length"

type

type: object

name

name: "Number" = "Number"

contentType

contentType: object

serializedName

serializedName: string = "content-type"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpBatchFileIsdirectory

ocpBatchFileIsdirectory: object

serializedName

serializedName: string = "ocp-batch-file-isdirectory"

type

type: object

name

name: "Boolean" = "Boolean"

ocpBatchFileMode

ocpBatchFileMode: object

serializedName

serializedName: string = "ocp-batch-file-mode"

type

type: object

name

name: "String" = "String"

ocpBatchFileUrl

ocpBatchFileUrl: object

serializedName

serializedName: string = "ocp-batch-file-url"

type

type: object

name

name: "String" = "String"

ocpCreationTime

ocpCreationTime: object

serializedName

serializedName: string = "ocp-creation-time"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const FileGetPropertiesFromTaskOptions

FileGetPropertiesFromTaskOptions: object

Additional parameters for getPropertiesFromTask operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileGetPropertiesFromTaskOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileListFromComputeNodeHeaders

FileListFromComputeNodeHeaders: object

Defines headers for ListFromComputeNode operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-listfromcomputenode-headers"

type

type: object

className

className: string = "FileListFromComputeNodeHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const FileListFromComputeNodeNextOptions

FileListFromComputeNodeNextOptions: object

Additional parameters for listFromComputeNodeNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "FileListFromComputeNodeNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const FileListFromComputeNodeOptions

FileListFromComputeNodeOptions: object

Additional parameters for listFromComputeNode operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 files can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileListFromComputeNodeOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileListFromTaskHeaders

FileListFromTaskHeaders: object

Defines headers for ListFromTask operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "file-listfromtask-headers"

type

type: object

className

className: string = "FileListFromTaskHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const FileListFromTaskNextOptions

FileListFromTaskNextOptions: object

Additional parameters for listFromTaskNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "FileListFromTaskNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const FileListFromTaskOptions

FileListFromTaskOptions: object

Additional parameters for listFromTask operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 files can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "FileListFromTaskOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const FileProperties

FileProperties: object

An interface representing FileProperties.

summary

The properties of a file on a compute node.

contentLength

contentLength: number

The length of the file.

Optional contentType

contentType: undefined | string

The content type of the file.

Optional creationTime

creationTime: Date

The file creation time. The creation time is not returned for files on Linux compute nodes.

Optional fileMode

fileMode: undefined | string

The file mode attribute in octal format. The file mode is returned only for files on Linux compute nodes.

lastModified

lastModified: Date

The time at which the file was last modified.

serializedName

serializedName: string = "FileProperties"

type

type: object

className

className: string = "FileProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentLength

contentLength: object

required

required: true = true

serializedName

serializedName: string = "contentLength"

type

type: object

name

name: "Number" = "Number"

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: "String" = "String"

creationTime

creationTime: object

serializedName

serializedName: string = "creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

fileMode

fileMode: object

serializedName

serializedName: string = "fileMode"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

required

required: true = true

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

Const ImageReference

ImageReference: object

An interface representing ImageReference.

summary

A reference to an Azure Virtual Machines Marketplace image or a custom Azure Virtual Machine image. To get the list of all Azure Marketplace image references verified by Azure Batch, see the 'List node agent SKUs' operation.

Optional offer

offer: undefined | string

The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer.

Optional publisher

publisher: undefined | string

The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.

Optional sku

sku: undefined | string

The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter.

Optional version

version: undefined | string

The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'.

Optional virtualMachineImageId

virtualMachineImageId: undefined | string

The ARM resource identifier of the virtual machine image. Computes nodes of the pool will be created using this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. This property is mutually exclusive with other ImageReference properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For more details, see https://docs.microsoft.com/azure/batch/batch-custom-images.

serializedName

serializedName: string = "ImageReference"

type

type: object

className

className: string = "ImageReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

offer

offer: object

serializedName

serializedName: string = "offer"

type

type: object

name

name: "String" = "String"

publisher

publisher: object

serializedName

serializedName: string = "publisher"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

virtualMachineImageId

virtualMachineImageId: object

serializedName

serializedName: string = "virtualMachineImageId"

type

type: object

name

name: "String" = "String"

Const InboundEndpoint

InboundEndpoint: object

An interface representing InboundEndpoint.

summary

An inbound endpoint on a compute node.

backendPort

backendPort: number

The backend port number of the endpoint.

frontendPort

frontendPort: number

The public port number of the endpoint.

name

name: string

The name of the endpoint.

protocol

The protocol of the endpoint. Possible values include: 'tcp', 'udp'

publicFQDN

publicFQDN: string

The public fully qualified domain name for the compute node.

publicIPAddress

publicIPAddress: string

The public IP address of the compute node.

serializedName

serializedName: string = "InboundEndpoint"

type

type: object

className

className: string = "InboundEndpoint"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

required

required: true = true

serializedName

serializedName: string = "backendPort"

type

type: object

name

name: "Number" = "Number"

frontendPort

frontendPort: object

required

required: true = true

serializedName

serializedName: string = "frontendPort"

type

type: object

name

name: "Number" = "Number"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "protocol"

type

type: object

allowedValues

allowedValues: string[] = ["tcp","udp"]

name

name: "Enum" = "Enum"

publicFQDN

publicFQDN: object

required

required: true = true

serializedName

serializedName: string = "publicFQDN"

type

type: object

name

name: "String" = "String"

publicIPAddress

publicIPAddress: object

required

required: true = true

serializedName

serializedName: string = "publicIPAddress"

type

type: object

name

name: "String" = "String"

Const InboundNATPool

InboundNATPool: object

An interface representing InboundNATPool.

summary

A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.

backendPort

backendPort: number

The port number on the compute node. This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400.

frontendPortRangeEnd

frontendPortRangeEnd: number

The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

frontendPortRangeStart

frontendPortRangeStart: number

The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400.

name

name: string

The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400.

Optional networkSecurityGroupRules

networkSecurityGroupRules: NetworkSecurityGroupRule[]

A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.

protocol

The protocol of the endpoint. Possible values include: 'tcp', 'udp'

serializedName

serializedName: string = "InboundNATPool"

type

type: object

className

className: string = "InboundNATPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backendPort

backendPort: object

required

required: true = true

serializedName

serializedName: string = "backendPort"

type

type: object

name

name: "Number" = "Number"

frontendPortRangeEnd

frontendPortRangeEnd: object

required

required: true = true

serializedName

serializedName: string = "frontendPortRangeEnd"

type

type: object

name

name: "Number" = "Number"

frontendPortRangeStart

frontendPortRangeStart: object

required

required: true = true

serializedName

serializedName: string = "frontendPortRangeStart"

type

type: object

name

name: "Number" = "Number"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

networkSecurityGroupRules

networkSecurityGroupRules: object

serializedName

serializedName: string = "networkSecurityGroupRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkSecurityGroupRule"

name

name: "Composite" = "Composite"

protocol

protocol: object

required

required: true = true

serializedName

serializedName: string = "protocol"

type

type: object

allowedValues

allowedValues: string[] = ["tcp","udp"]

name

name: "Enum" = "Enum"

Const JobAddHeaders

JobAddHeaders: object

Defines headers for Add operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-add-headers"

type

type: object

className

className: string = "JobAddHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobAddOptions

JobAddOptions: object

Additional parameters for add operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobAddOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobAddParameter

JobAddParameter: object

An interface representing JobAddParameter.

summary

An Azure Batch job to add.

Optional commonEnvironmentSettings

commonEnvironmentSettings: EnvironmentSetting[]

The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks). Individual tasks can override an environment setting specified here by specifying the same setting name with a different value.

Optional constraints

constraints: JobConstraints

The execution constraints for the job.

Optional displayName

displayName: undefined | string

The display name for the job. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

id

id: string

A string that uniquely identifies the job within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

Optional jobManagerTask

jobManagerTask: JobManagerTask

Details of a Job Manager task to be launched when the job is started. If the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents.

Optional jobPreparationTask

jobPreparationTask: JobPreparationTask

The Job Preparation task. If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.

Optional jobReleaseTask

jobReleaseTask: JobReleaseTask

The Job Release task. A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Optional networkConfiguration

networkConfiguration: JobNetworkConfiguration

The network configuration for the job.

Optional onAllTasksComplete

onAllTasksComplete: OnAllTasksComplete

The action the Batch service should take when all tasks in the job are in the completed state. Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'

Optional onTaskFailure

onTaskFailure: OnTaskFailure

The action the Batch service should take when any task in the job fails. A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'

poolInfo

poolInfo: PoolInformation

The pool on which the Batch service runs the job's tasks.

Optional priority

priority: undefined | number

The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.

Optional usesTaskDependencies

usesTaskDependencies: undefined | false | true

Whether tasks in the job can define dependencies on each other. The default is false.

serializedName

serializedName: string = "JobAddParameter"

type

type: object

className

className: string = "JobAddParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commonEnvironmentSettings

commonEnvironmentSettings: object

serializedName

serializedName: string = "commonEnvironmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "JobConstraints"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

jobManagerTask

jobManagerTask: object

serializedName

serializedName: string = "jobManagerTask"

type

type: object

className

className: string = "JobManagerTask"

name

name: "Composite" = "Composite"

jobPreparationTask

jobPreparationTask: object

serializedName

serializedName: string = "jobPreparationTask"

type

type: object

className

className: string = "JobPreparationTask"

name

name: "Composite" = "Composite"

jobReleaseTask

jobReleaseTask: object

serializedName

serializedName: string = "jobReleaseTask"

type

type: object

className

className: string = "JobReleaseTask"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

networkConfiguration

networkConfiguration: object

serializedName

serializedName: string = "networkConfiguration"

type

type: object

className

className: string = "JobNetworkConfiguration"

name

name: "Composite" = "Composite"

onAllTasksComplete

onAllTasksComplete: object

serializedName

serializedName: string = "onAllTasksComplete"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","terminatejob"]

name

name: "Enum" = "Enum"

onTaskFailure

onTaskFailure: object

serializedName

serializedName: string = "onTaskFailure"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","performexitoptionsjobaction"]

name

name: "Enum" = "Enum"

poolInfo

poolInfo: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "poolInfo"

type

type: object

className

className: string = "PoolInformation"

name

name: "Composite" = "Composite"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

usesTaskDependencies

usesTaskDependencies: object

serializedName

serializedName: string = "usesTaskDependencies"

type

type: object

name

name: "Boolean" = "Boolean"

Const JobConstraints

JobConstraints: object

An interface representing JobConstraints.

summary

The execution constraints for a job.

Optional maxTaskRetryCount

maxTaskRetryCount: undefined | number

The maximum number of times each task may be retried. The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry tasks. If the maximum retry count is -1, the Batch service retries tasks without limit. The default value is 0 (no retries).

Optional maxWallClockTime

maxWallClockTime: undefined | string

The maximum elapsed time that the job may run, measured from the time the job is created. If the job does not complete within the time limit, the Batch service terminates it and any tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the job may run.

serializedName

serializedName: string = "JobConstraints"

type

type: object

className

className: string = "JobConstraints"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxTaskRetryCount

maxTaskRetryCount: object

serializedName

serializedName: string = "maxTaskRetryCount"

type

type: object

name

name: "Number" = "Number"

maxWallClockTime

maxWallClockTime: object

serializedName

serializedName: string = "maxWallClockTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const JobDeleteHeaders

JobDeleteHeaders: object

Defines headers for Delete operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-delete-headers"

type

type: object

className

className: string = "JobDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const JobDeleteMethodOptions

JobDeleteMethodOptions: object

Additional parameters for deleteMethod operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobDeleteMethodOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobDisableHeaders

JobDisableHeaders: object

Defines headers for Disable operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-disable-headers"

type

type: object

className

className: string = "JobDisableHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobDisableOptions

JobDisableOptions: object

Additional parameters for disable operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobDisableOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobDisableParameter

JobDisableParameter: object

An interface representing JobDisableParameter.

summary

Options when disabling a job.

disableTasks

disableTasks: DisableJobOption

What to do with active tasks associated with the job. Possible values include: 'requeue', 'terminate', 'wait'

serializedName

serializedName: string = "JobDisableParameter"

type

type: object

className

className: string = "JobDisableParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

disableTasks

disableTasks: object

required

required: true = true

serializedName

serializedName: string = "disableTasks"

type

type: object

allowedValues

allowedValues: string[] = ["requeue","terminate","wait"]

name

name: "Enum" = "Enum"

Const JobEnableHeaders

JobEnableHeaders: object

Defines headers for Enable operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-enable-headers"

type

type: object

className

className: string = "JobEnableHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobEnableOptions

JobEnableOptions: object

Additional parameters for enable operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobEnableOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobExecutionInformation

JobExecutionInformation: object

An interface representing JobExecutionInformation.

summary

Contains information about the execution of a job in the Azure Batch service.

Optional endTime

endTime: Date

The completion time of the job. This property is set only if the job is in the completed state.

Optional poolId

poolId: undefined | string

The ID of the pool to which this job is assigned. This element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the ID of that auto pool.

Optional schedulingError

schedulingError: JobSchedulingError

Details of any error encountered by the service in starting the job. This property is not set if there was no error starting the job.

startTime

startTime: Date

The start time of the job. This is the time at which the job was created.

Optional terminateReason

terminateReason: undefined | string

A string describing the reason the job ended. This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule

  • the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation.

serializedName

serializedName: string = "JobExecutionInformation"

type

type: object

className

className: string = "JobExecutionInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

poolId

poolId: object

serializedName

serializedName: string = "poolId"

type

type: object

name

name: "String" = "String"

schedulingError

schedulingError: object

serializedName

serializedName: string = "schedulingError"

type

type: object

className

className: string = "JobSchedulingError"

name

name: "Composite" = "Composite"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

terminateReason

terminateReason: object

serializedName

serializedName: string = "terminateReason"

type

type: object

name

name: "String" = "String"

Const JobGetAllLifetimeStatisticsHeaders

JobGetAllLifetimeStatisticsHeaders: object

Defines headers for GetAllLifetimeStatistics operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-getalllifetimestatistics-headers"

type

type: object

className

className: string = "JobGetAllLifetimeStatisticsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobGetAllLifetimeStatisticsOptions

JobGetAllLifetimeStatisticsOptions: object

Additional parameters for getAllLifetimeStatistics operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobGetAllLifetimeStatisticsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobGetHeaders

JobGetHeaders: object

Defines headers for Get operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTagHeader

eTagHeader: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModifiedHeader

lastModifiedHeader: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-get-headers"

type

type: object

className

className: string = "JobGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTagHeader

eTagHeader: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModifiedHeader

lastModifiedHeader: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobGetOptions

JobGetOptions: object

Additional parameters for get operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobGetOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobGetTaskCountsHeaders

JobGetTaskCountsHeaders: object

Defines headers for GetTaskCounts operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-gettaskcounts-headers"

type

type: object

className

className: string = "JobGetTaskCountsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobGetTaskCountsOptions

JobGetTaskCountsOptions: object

Additional parameters for getTaskCounts operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobGetTaskCountsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobListFromJobScheduleHeaders

JobListFromJobScheduleHeaders: object

Defines headers for ListFromJobSchedule operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-listfromjobschedule-headers"

type

type: object

className

className: string = "JobListFromJobScheduleHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobListFromJobScheduleNextOptions

JobListFromJobScheduleNextOptions: object

Additional parameters for listFromJobScheduleNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "JobListFromJobScheduleNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const JobListFromJobScheduleOptions

JobListFromJobScheduleOptions: object

Additional parameters for listFromJobSchedule operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobListFromJobScheduleOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobListHeaders

JobListHeaders: object

Defines headers for List operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-list-headers"

type

type: object

className

className: string = "JobListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobListNextOptions

JobListNextOptions: object

Additional parameters for listNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "JobListNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const JobListOptions

JobListOptions: object

Additional parameters for list operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobListOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobListPreparationAndReleaseTaskStatusHeaders

JobListPreparationAndReleaseTaskStatusHeaders: object

Defines headers for ListPreparationAndReleaseTaskStatus operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-listpreparationandreleasetaskstatus-headers"

type

type: object

className

className: string = "JobListPreparationAndReleaseTaskStatusHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobListPreparationAndReleaseTaskStatusNextOptions

JobListPreparationAndReleaseTaskStatusNextOptions: object

Additional parameters for listPreparationAndReleaseTaskStatusNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "JobListPreparationAndReleaseTaskStatusNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const JobListPreparationAndReleaseTaskStatusOptions

JobListPreparationAndReleaseTaskStatusOptions: object

Additional parameters for listPreparationAndReleaseTaskStatus operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 tasks can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobListPreparationAndReleaseTaskStatusOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobManagerTask

JobManagerTask: object

The Job Manager task is automatically started when the job is created. The Batch service tries to schedule the Job Manager task before any other tasks in the job. When shrinking a pool, the Batch service tries to preserve compute nodes where Job Manager tasks are running for as long as possible (that is, nodes running 'normal' tasks are removed before nodes running Job Manager tasks). When a Job Manager task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle nodes available, the system may terminate one of the running tasks in the pool and return it to the queue in order to make room for the Job Manager task to restart. Note that a Job Manager task in one job does not have priority over tasks in other jobs. Across jobs, only job level priorities are observed. For example, if a Job Manager in a priority 0 job needs to be restarted, it will not displace tasks of a priority 1 job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.

summary

Specifies details of a Job Manager task.

Optional allowLowPriorityNode

allowLowPriorityNode: undefined | false | true

Whether the Job Manager task may run on a low-priority compute node. The default value is true.

Optional applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

A list of application packages that the Batch service will deploy to the compute node before running the command line. Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails.

Optional authenticationTokenSettings

authenticationTokenSettings: AuthenticationTokenSettings

The settings for an authentication token that the task can use to perform Batch service operations. If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.

commandLine

commandLine: string

The command line of the Job Manager task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

Optional constraints

constraints: TaskConstraints

Constraints that apply to the Job Manager task.

Optional containerSettings

containerSettings: TaskContainerSettings

The settings for the container under which the Job Manager task runs. If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

Optional displayName

displayName: undefined | string

The display name of the Job Manager task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Optional environmentSettings

environmentSettings: EnvironmentSetting[]

A list of environment variable settings for the Job Manager task.

id

id: string

A string that uniquely identifies the Job Manager task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters.

Optional killJobOnCompletion

killJobOnCompletion: undefined | false | true

Whether completion of the Job Manager task signifies completion of the entire job. If true, when the Job Manager task completes, the Batch service marks the job as complete. If any tasks are still running at this time (other than Job Release), those tasks are terminated. If false, the completion of the Job Manager task does not affect the job status. In this case, you should either use the onAllTasksComplete attribute to terminate the job, or have a client or user terminate the job explicitly. An example of this is if the Job Manager creates a set of tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control job lifetime, and using the Job Manager task only to create the tasks for the job (not to monitor progress), then it is important to set killJobOnCompletion to false.

Optional outputFiles

outputFiles: OutputFile[]

A list of files that the Batch service will upload from the compute node after running the command line. For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.

Optional resourceFiles

resourceFiles: ResourceFile[]

A list of files that the Batch service will download to the compute node before running the command line. Files listed under this element are located in the task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

Optional runExclusive

runExclusive: undefined | false | true

Whether the Job Manager task requires exclusive use of the compute node where it runs. If true, no other tasks will run on the same compute node for as long as the Job Manager is running. If false, other tasks can run simultaneously with the Job Manager on a compute node. The Job Manager task counts normally against the node's concurrent task limit, so this is only relevant if the node allows multiple concurrent tasks. The default value is true.

Optional userIdentity

userIdentity: UserIdentity

The user identity under which the Job Manager task runs. If omitted, the task runs as a non-administrative user unique to the task.

serializedName

serializedName: string = "JobManagerTask"

type

type: object

className

className: string = "JobManagerTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowLowPriorityNode

allowLowPriorityNode: object

serializedName

serializedName: string = "allowLowPriorityNode"

type

type: object

name

name: "Boolean" = "Boolean"

applicationPackageReferences

applicationPackageReferences: object

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

authenticationTokenSettings

authenticationTokenSettings: object

serializedName

serializedName: string = "authenticationTokenSettings"

type

type: object

className

className: string = "AuthenticationTokenSettings"

name

name: "Composite" = "Composite"

commandLine

commandLine: object

required

required: true = true

serializedName

serializedName: string = "commandLine"

type

type: object

name

name: "String" = "String"

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "TaskConstraints"

name

name: "Composite" = "Composite"

containerSettings

containerSettings: object

serializedName

serializedName: string = "containerSettings"

type

type: object

className

className: string = "TaskContainerSettings"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

environmentSettings

environmentSettings: object

serializedName

serializedName: string = "environmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

killJobOnCompletion

killJobOnCompletion: object

serializedName

serializedName: string = "killJobOnCompletion"

type

type: object

name

name: "Boolean" = "Boolean"

outputFiles

outputFiles: object

serializedName

serializedName: string = "outputFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OutputFile"

name

name: "Composite" = "Composite"

resourceFiles

resourceFiles: object

serializedName

serializedName: string = "resourceFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

runExclusive

runExclusive: object

serializedName

serializedName: string = "runExclusive"

type

type: object

name

name: "Boolean" = "Boolean"

userIdentity

userIdentity: object

serializedName

serializedName: string = "userIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

Const JobNetworkConfiguration

JobNetworkConfiguration: object

An interface representing JobNetworkConfiguration.

summary

The network configuration for the job.

subnetId

subnetId: string

The ARM resource identifier of the virtual network subnet which nodes running tasks from the job will join for the duration of the task. This is only supported for jobs running on VirtualMachineConfiguration pools. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes which will run tasks from the job. For more details, see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

serializedName

serializedName: string = "JobNetworkConfiguration"

type

type: object

className

className: string = "JobNetworkConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

subnetId

subnetId: object

required

required: true = true

serializedName

serializedName: string = "subnetId"

type

type: object

name

name: "String" = "String"

Const JobPatchHeaders

JobPatchHeaders: object

Defines headers for Patch operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-patch-headers"

type

type: object

className

className: string = "JobPatchHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobPatchOptions

JobPatchOptions: object

Additional parameters for patch operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobPatchOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobPatchParameter

JobPatchParameter: object

An interface representing JobPatchParameter.

summary

The set of changes to be made to a job.

Optional constraints

constraints: JobConstraints

The execution constraints for the job. If omitted, the existing execution constraints are left unchanged.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the job as metadata. If omitted, the existing job metadata is left unchanged.

Optional onAllTasksComplete

onAllTasksComplete: OnAllTasksComplete

The action the Batch service should take when all tasks in the job are in the completed state. If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'noAction', 'terminateJob'

Optional poolInfo

poolInfo: PoolInformation

The pool on which the Batch service runs the job's tasks. You may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool.

Optional priority

priority: undefined | number

The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged.

serializedName

serializedName: string = "JobPatchParameter"

type

type: object

className

className: string = "JobPatchParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "JobConstraints"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

onAllTasksComplete

onAllTasksComplete: object

serializedName

serializedName: string = "onAllTasksComplete"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","terminatejob"]

name

name: "Enum" = "Enum"

poolInfo

poolInfo: object

serializedName

serializedName: string = "poolInfo"

type

type: object

className

className: string = "PoolInformation"

name

name: "Composite" = "Composite"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

Const JobPreparationAndReleaseTaskExecutionInformation

JobPreparationAndReleaseTaskExecutionInformation: object

An interface representing JobPreparationAndReleaseTaskExecutionInformation.

summary

The status of the Job Preparation and Job Release tasks on a compute node.

Optional jobPreparationTaskExecutionInfo

jobPreparationTaskExecutionInfo: JobPreparationTaskExecutionInformation

Information about the execution status of the Job Preparation task on this compute node.

Optional jobReleaseTaskExecutionInfo

jobReleaseTaskExecutionInfo: JobReleaseTaskExecutionInformation

Information about the execution status of the Job Release task on this compute node. This property is set only if the Job Release task has run on the node.

Optional nodeId

nodeId: undefined | string

The ID of the compute node to which this entry refers.

Optional nodeUrl

nodeUrl: undefined | string

The URL of the compute node to which this entry refers.

Optional poolId

poolId: undefined | string

The ID of the pool containing the compute node to which this entry refers.

serializedName

serializedName: string = "JobPreparationAndReleaseTaskExecutionInformation"

type

type: object

className

className: string = "JobPreparationAndReleaseTaskExecutionInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

jobPreparationTaskExecutionInfo

jobPreparationTaskExecutionInfo: object

serializedName

serializedName: string = "jobPreparationTaskExecutionInfo"

type

type: object

className

className: string = "JobPreparationTaskExecutionInformation"

name

name: "Composite" = "Composite"

jobReleaseTaskExecutionInfo

jobReleaseTaskExecutionInfo: object

serializedName

serializedName: string = "jobReleaseTaskExecutionInfo"

type

type: object

className

className: string = "JobReleaseTaskExecutionInformation"

name

name: "Composite" = "Composite"

nodeId

nodeId: object

serializedName

serializedName: string = "nodeId"

type

type: object

name

name: "String" = "String"

nodeUrl

nodeUrl: object

serializedName

serializedName: string = "nodeUrl"

type

type: object

name

name: "String" = "String"

poolId

poolId: object

serializedName

serializedName: string = "poolId"

type

type: object

name

name: "String" = "String"

Const JobPreparationTask

JobPreparationTask: object

You can use Job Preparation to prepare a compute node to run tasks for the job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the tasks in the job. The Job Preparation task can download these common resource files to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the compute node so that all tasks of that job can communicate with it. If the Job Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run tasks of this job on the compute node. The node remains ineligible to run tasks of this job until it is reimaged. The node remains active and can be used for other jobs. The Job Preparation task can run multiple times on the same compute node. Therefore, you should write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job Preparation task is run again on the node before scheduling any other task of the job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously complete. If the compute node is reimaged, the Job Preparation task is run again before scheduling any task of the job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.

summary

A Job Preparation task to run before any tasks of the job on any given compute node.

commandLine

commandLine: string

The command line of the Job Preparation task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

Optional constraints

constraints: TaskConstraints

Constraints that apply to the Job Preparation task.

Optional containerSettings

containerSettings: TaskContainerSettings

The settings for the container under which the Job Preparation task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

Optional environmentSettings

environmentSettings: EnvironmentSetting[]

A list of environment variable settings for the Job Preparation task.

Optional id

id: undefined | string

A string that uniquely identifies the Job Preparation task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other task in the job can have the same ID as the Job Preparation task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).

Optional rerunOnNodeRebootAfterSuccess

rerunOnNodeRebootAfterSuccess: undefined | false | true

Whether the Batch service should rerun the Job Preparation task after a compute node reboots. The Job Preparation task is always rerun if a compute node is reimaged, or if the Job Preparation task did not complete (e.g. because the reboot occurred while the task was running). Therefore, you should always write a Job Preparation task to be idempotent and to behave correctly if run multiple times. The default value is true.

Optional resourceFiles

resourceFiles: ResourceFile[]

A list of files that the Batch service will download to the compute node before running the command line. Files listed under this element are located in the task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

Optional userIdentity

userIdentity: UserIdentity

The user identity under which the Job Preparation task runs. If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a non-administrative user unique to the pool on Linux nodes.

Optional waitForSuccess

waitForSuccess: undefined | false | true

Whether the Batch service should wait for the Job Preparation task to complete successfully before scheduling any other tasks of the job on the compute node. A Job Preparation task has completed successfully if it exits with exit code 0. If true and the Job Preparation task fails on a compute node, the Batch service retries the Job Preparation task up to its maximum retry count (as specified in the constraints element). If the task has still not completed successfully after all retries, then the Batch service will not schedule tasks of the job to the compute node. The compute node remains active and eligible to run tasks of other jobs. If false, the Batch service will not wait for the Job Preparation task to complete. In this case, other tasks of the job can start executing on the compute node while the Job Preparation task is still running; and even if the Job Preparation task fails, new tasks will continue to be scheduled on the node. The default value is true.

serializedName

serializedName: string = "JobPreparationTask"

type

type: object

className

className: string = "JobPreparationTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commandLine

commandLine: object

required

required: true = true

serializedName

serializedName: string = "commandLine"

type

type: object

name

name: "String" = "String"

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "TaskConstraints"

name

name: "Composite" = "Composite"

containerSettings

containerSettings: object

serializedName

serializedName: string = "containerSettings"

type

type: object

className

className: string = "TaskContainerSettings"

name

name: "Composite" = "Composite"

environmentSettings

environmentSettings: object

serializedName

serializedName: string = "environmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

rerunOnNodeRebootAfterSuccess

rerunOnNodeRebootAfterSuccess: object

serializedName

serializedName: string = "rerunOnNodeRebootAfterSuccess"

type

type: object

name

name: "Boolean" = "Boolean"

resourceFiles

resourceFiles: object

serializedName

serializedName: string = "resourceFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

userIdentity

userIdentity: object

serializedName

serializedName: string = "userIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

waitForSuccess

waitForSuccess: object

serializedName

serializedName: string = "waitForSuccess"

type

type: object

name

name: "Boolean" = "Boolean"

Const JobPreparationTaskExecutionInformation

JobPreparationTaskExecutionInformation: object

An interface representing JobPreparationTaskExecutionInformation.

summary

Contains information about the execution of a Job Preparation task on a compute node.

Optional containerInfo

Information about the container under which the task is executing. This property is set only if the task runs in a container context.

Optional endTime

endTime: Date

The time at which the Job Preparation task completed. This property is set only if the task is in the Completed state.

Optional exitCode

exitCode: undefined | number

The exit code of the program specified on the task command line. This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated.

Optional failureInfo

Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.

Optional lastRetryTime

lastRetryTime: Date

The most recent time at which a retry of the Job Preparation task started running. This property is set only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.

Optional result

The result of the task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'

retryCount

retryCount: number

The number of times the task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.

startTime

startTime: Date

The time at which the task started running. If the task has been restarted or retried, this is the most recent time at which the task started running.

state

The current state of the Job Preparation task on the compute node. Possible values include: 'running', 'completed'

Optional taskRootDirectory

taskRootDirectory: undefined | string

The root directory of the Job Preparation task on the compute node. You can use this path to retrieve files created by the task, such as log files.

Optional taskRootDirectoryUrl

taskRootDirectoryUrl: undefined | string

The URL to the root directory of the Job Preparation task on the compute node.

serializedName

serializedName: string = "JobPreparationTaskExecutionInformation"

type

type: object

className

className: string = "JobPreparationTaskExecutionInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerInfo

containerInfo: object

serializedName

serializedName: string = "containerInfo"

type

type: object

className

className: string = "TaskContainerExecutionInformation"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exitCode

exitCode: object

serializedName

serializedName: string = "exitCode"

type

type: object

name

name: "Number" = "Number"

failureInfo

failureInfo: object

serializedName

serializedName: string = "failureInfo"

type

type: object

className

className: string = "TaskFailureInformation"

name

name: "Composite" = "Composite"

lastRetryTime

lastRetryTime: object

serializedName

serializedName: string = "lastRetryTime"

type

type: object

name

name: "DateTime" = "DateTime"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

allowedValues

allowedValues: string[] = ["success","failure"]

name

name: "Enum" = "Enum"

retryCount

retryCount: object

required

required: true = true

serializedName

serializedName: string = "retryCount"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

required

required: true = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["running","completed"]

name

name: "Enum" = "Enum"

taskRootDirectory

taskRootDirectory: object

serializedName

serializedName: string = "taskRootDirectory"

type

type: object

name

name: "String" = "String"

taskRootDirectoryUrl

taskRootDirectoryUrl: object

serializedName

serializedName: string = "taskRootDirectoryUrl"

type

type: object

name

name: "String" = "String"

Const JobReleaseTask

JobReleaseTask: object

The Job Release task runs when the job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the job is still active, the job's maximum wall clock time constraint is reached, and the job is still active, or the job's Job Manager task completed, and the job is configured to terminate when the Job Manager completes. The Job Release task runs on each compute node where tasks of the job have run and the Job Preparation task ran and completed. If you reimage a compute node after it has run the Job Preparation task, and the job ends without any further tasks of the job running on that compute node (and hence the Job Preparation task does not re-run), then the Job Release task does not run on that node. If a compute node reboots while the Job Release task is still running, the Job Release task runs again when the compute node starts up. The job is not marked as complete until all Job Release tasks have completed. The Job Release task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified on the pool.

summary

A Job Release task to run on job completion on any compute node where the job has run.

commandLine

commandLine: string

The command line of the Job Release task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

Optional containerSettings

containerSettings: TaskContainerSettings

The settings for the container under which the Job Release task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

Optional environmentSettings

environmentSettings: EnvironmentSetting[]

A list of environment variable settings for the Job Release task.

Optional id

id: undefined | string

A string that uniquely identifies the Job Release task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other task in the job can have the same ID as the Job Release task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).

Optional maxWallClockTime

maxWallClockTime: undefined | string

The maximum elapsed time that the Job Release task may run on a given compute node, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional resourceFiles

resourceFiles: ResourceFile[]

A list of files that the Batch service will download to the compute node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the task's working directory.

Optional retentionTime

retentionTime: undefined | string

The minimum time to retain the task directory for the Job Release task on the compute node. After this time, the Batch service may delete the task directory and all its contents. The default is 7 days, i.e. the task directory will be retained for 7 days unless the compute node is removed or the job is deleted.

Optional userIdentity

userIdentity: UserIdentity

The user identity under which the Job Release task runs. If omitted, the task runs as a non-administrative user unique to the task.

serializedName

serializedName: string = "JobReleaseTask"

type

type: object

className

className: string = "JobReleaseTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commandLine

commandLine: object

required

required: true = true

serializedName

serializedName: string = "commandLine"

type

type: object

name

name: "String" = "String"

containerSettings

containerSettings: object

serializedName

serializedName: string = "containerSettings"

type

type: object

className

className: string = "TaskContainerSettings"

name

name: "Composite" = "Composite"

environmentSettings

environmentSettings: object

serializedName

serializedName: string = "environmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

maxWallClockTime

maxWallClockTime: object

serializedName

serializedName: string = "maxWallClockTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

resourceFiles

resourceFiles: object

serializedName

serializedName: string = "resourceFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

retentionTime

retentionTime: object

serializedName

serializedName: string = "retentionTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

userIdentity

userIdentity: object

serializedName

serializedName: string = "userIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

Const JobReleaseTaskExecutionInformation

JobReleaseTaskExecutionInformation: object

An interface representing JobReleaseTaskExecutionInformation.

summary

Contains information about the execution of a Job Release task on a compute node.

Optional containerInfo

Information about the container under which the task is executing. This property is set only if the task runs in a container context.

Optional endTime

endTime: Date

The time at which the Job Release task completed. This property is set only if the task is in the Completed state.

Optional exitCode

exitCode: undefined | number

The exit code of the program specified on the task command line. This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated.

Optional failureInfo

Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.

Optional result

The result of the task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'

startTime

startTime: Date

The time at which the task started running. If the task has been restarted or retried, this is the most recent time at which the task started running.

state

The current state of the Job Release task on the compute node. Possible values include: 'running', 'completed'

Optional taskRootDirectory

taskRootDirectory: undefined | string

The root directory of the Job Release task on the compute node. You can use this path to retrieve files created by the task, such as log files.

Optional taskRootDirectoryUrl

taskRootDirectoryUrl: undefined | string

The URL to the root directory of the Job Release task on the compute node.

serializedName

serializedName: string = "JobReleaseTaskExecutionInformation"

type

type: object

className

className: string = "JobReleaseTaskExecutionInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerInfo

containerInfo: object

serializedName

serializedName: string = "containerInfo"

type

type: object

className

className: string = "TaskContainerExecutionInformation"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exitCode

exitCode: object

serializedName

serializedName: string = "exitCode"

type

type: object

name

name: "Number" = "Number"

failureInfo

failureInfo: object

serializedName

serializedName: string = "failureInfo"

type

type: object

className

className: string = "TaskFailureInformation"

name

name: "Composite" = "Composite"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

allowedValues

allowedValues: string[] = ["success","failure"]

name

name: "Enum" = "Enum"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

required

required: true = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["running","completed"]

name

name: "Enum" = "Enum"

taskRootDirectory

taskRootDirectory: object

serializedName

serializedName: string = "taskRootDirectory"

type

type: object

name

name: "String" = "String"

taskRootDirectoryUrl

taskRootDirectoryUrl: object

serializedName

serializedName: string = "taskRootDirectoryUrl"

type

type: object

name

name: "String" = "String"

Const JobScheduleAddHeaders

JobScheduleAddHeaders: object

Defines headers for Add operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-add-headers"

type

type: object

className

className: string = "JobScheduleAddHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleAddOptions

JobScheduleAddOptions: object

Additional parameters for add operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleAddOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleAddParameter

JobScheduleAddParameter: object

An interface representing JobScheduleAddParameter.

summary

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

Optional displayName

displayName: undefined | string

The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

id

id: string

A string that uniquely identifies the schedule within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

jobSpecification

jobSpecification: JobSpecification

The details of the jobs to be created on this schedule.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

schedule

schedule: Schedule

The schedule according to which jobs will be created.

serializedName

serializedName: string = "JobScheduleAddParameter"

type

type: object

className

className: string = "JobScheduleAddParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

jobSpecification

jobSpecification: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "jobSpecification"

type

type: object

className

className: string = "JobSpecification"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

schedule

schedule: object

required

required: true = true

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

Const JobScheduleDeleteHeaders

JobScheduleDeleteHeaders: object

Defines headers for Delete operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-delete-headers"

type

type: object

className

className: string = "JobScheduleDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const JobScheduleDeleteMethodOptions

JobScheduleDeleteMethodOptions: object

Additional parameters for deleteMethod operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleDeleteMethodOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleDisableHeaders

JobScheduleDisableHeaders: object

Defines headers for Disable operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-disable-headers"

type

type: object

className

className: string = "JobScheduleDisableHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleDisableOptions

JobScheduleDisableOptions: object

Additional parameters for disable operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleDisableOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleEnableHeaders

JobScheduleEnableHeaders: object

Defines headers for Enable operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-enable-headers"

type

type: object

className

className: string = "JobScheduleEnableHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleEnableOptions

JobScheduleEnableOptions: object

Additional parameters for enable operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleEnableOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleExecutionInformation

JobScheduleExecutionInformation: object

An interface representing JobScheduleExecutionInformation.

summary

Contains information about jobs that have been and will be run under a job schedule.

Optional endTime

endTime: Date

The time at which the schedule ended. This property is set only if the job schedule is in the completed state.

Optional nextRunTime

nextRunTime: Date

The next time at which a job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no job will be created at nextRunTime unless the job is enabled before then.

Optional recentJob

recentJob: RecentJob

Information about the most recent job under the job schedule. This property is present only if the at least one job has run under the schedule.

serializedName

serializedName: string = "JobScheduleExecutionInformation"

type

type: object

className

className: string = "JobScheduleExecutionInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

nextRunTime

nextRunTime: object

serializedName

serializedName: string = "nextRunTime"

type

type: object

name

name: "DateTime" = "DateTime"

recentJob

recentJob: object

serializedName

serializedName: string = "recentJob"

type

type: object

className

className: string = "RecentJob"

name

name: "Composite" = "Composite"

Const JobScheduleExistsHeaders

JobScheduleExistsHeaders: object

Defines headers for Exists operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-exists-headers"

type

type: object

className

className: string = "JobScheduleExistsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleExistsOptions

JobScheduleExistsOptions: object

Additional parameters for exists operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleExistsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleGetHeaders

JobScheduleGetHeaders: object

Defines headers for Get operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTagHeader

eTagHeader: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModifiedHeader

lastModifiedHeader: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-get-headers"

type

type: object

className

className: string = "JobScheduleGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTagHeader

eTagHeader: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModifiedHeader

lastModifiedHeader: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleGetOptions

JobScheduleGetOptions: object

Additional parameters for get operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleGetOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleListHeaders

JobScheduleListHeaders: object

Defines headers for List operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-list-headers"

type

type: object

className

className: string = "JobScheduleListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleListNextOptions

JobScheduleListNextOptions: object

Additional parameters for listNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "JobScheduleListNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const JobScheduleListOptions

JobScheduleListOptions: object

Additional parameters for list operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 job schedules can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleListOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobSchedulePatchHeaders

JobSchedulePatchHeaders: object

Defines headers for Patch operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-patch-headers"

type

type: object

className

className: string = "JobSchedulePatchHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobSchedulePatchOptions

JobSchedulePatchOptions: object

Additional parameters for patch operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobSchedulePatchOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobSchedulePatchParameter

JobSchedulePatchParameter: object

An interface representing JobSchedulePatchParameter.

summary

The set of changes to be made to a job schedule.

Optional jobSpecification

jobSpecification: JobSpecification

The details of the jobs to be created on this schedule. Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the job schedule as metadata. If you do not specify this element, existing metadata is left unchanged.

Optional schedule

schedule: Schedule

The schedule according to which jobs will be created. If you do not specify this element, the existing schedule is left unchanged.

serializedName

serializedName: string = "JobSchedulePatchParameter"

type

type: object

className

className: string = "JobSchedulePatchParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

jobSpecification

jobSpecification: object

serializedName

serializedName: string = "jobSpecification"

type

type: object

className

className: string = "JobSpecification"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

schedule

schedule: object

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

Const JobScheduleStatistics

JobScheduleStatistics: object

An interface representing JobScheduleStatistics.

summary

Resource usage statistics for a job schedule.

kernelCPUTime

kernelCPUTime: string

The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule.

lastUpdateTime

lastUpdateTime: Date

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

numFailedTasks

numFailedTasks: number

The total number of tasks that failed during the given time range in jobs created under the schedule. A task fails if it exhausts its maximum retry count without returning exit code 0.

numSucceededTasks

numSucceededTasks: number

The total number of tasks successfully completed during the given time range in jobs created under the schedule. A task completes successfully if it returns exit code 0.

numTaskRetries

numTaskRetries: number

The total number of retries during the given time range on all tasks in all jobs created under the schedule.

readIOGiB

readIOGiB: number

The total gibibytes read from disk by all tasks in all jobs created under the schedule.

readIOps

readIOps: number

The total number of disk read operations made by all tasks in all jobs created under the schedule.

startTime

startTime: Date

The start time of the time range covered by the statistics.

url

url: string

The URL of the statistics.

userCPUTime

userCPUTime: string

The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule.

waitTime

waitTime: string

The total wait time of all tasks in all jobs created under the schedule. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.). This value is only reported in the account lifetime statistics; it is not included in the job statistics.

wallClockTime

wallClockTime: string

The total wall clock time of all the tasks in all the jobs created under the schedule. The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries.

writeIOGiB

writeIOGiB: number

The total gibibytes written to disk by all tasks in all jobs created under the schedule.

writeIOps

writeIOps: number

The total number of disk write operations made by all tasks in all jobs created under the schedule.

serializedName

serializedName: string = "JobScheduleStatistics"

type

type: object

className

className: string = "JobScheduleStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kernelCPUTime

kernelCPUTime: object

required

required: true = true

serializedName

serializedName: string = "kernelCPUTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

lastUpdateTime

lastUpdateTime: object

required

required: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

numFailedTasks

numFailedTasks: object

required

required: true = true

serializedName

serializedName: string = "numFailedTasks"

type

type: object

name

name: "Number" = "Number"

numSucceededTasks

numSucceededTasks: object

required

required: true = true

serializedName

serializedName: string = "numSucceededTasks"

type

type: object

name

name: "Number" = "Number"

numTaskRetries

numTaskRetries: object

required

required: true = true

serializedName

serializedName: string = "numTaskRetries"

type

type: object

name

name: "Number" = "Number"

readIOGiB

readIOGiB: object

required

required: true = true

serializedName

serializedName: string = "readIOGiB"

type

type: object

name

name: "Number" = "Number"

readIOps

readIOps: object

required

required: true = true

serializedName

serializedName: string = "readIOps"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

url

url: object

required

required: true = true

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

userCPUTime

userCPUTime: object

required

required: true = true

serializedName

serializedName: string = "userCPUTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

waitTime

waitTime: object

required

required: true = true

serializedName

serializedName: string = "waitTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

wallClockTime

wallClockTime: object

required

required: true = true

serializedName

serializedName: string = "wallClockTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

writeIOGiB

writeIOGiB: object

required

required: true = true

serializedName

serializedName: string = "writeIOGiB"

type

type: object

name

name: "Number" = "Number"

writeIOps

writeIOps: object

required

required: true = true

serializedName

serializedName: string = "writeIOps"

type

type: object

name

name: "Number" = "Number"

Const JobScheduleTerminateHeaders

JobScheduleTerminateHeaders: object

Defines headers for Terminate operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-terminate-headers"

type

type: object

className

className: string = "JobScheduleTerminateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleTerminateOptions

JobScheduleTerminateOptions: object

Additional parameters for terminate operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleTerminateOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleUpdateHeaders

JobScheduleUpdateHeaders: object

Defines headers for Update operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "jobschedule-update-headers"

type

type: object

className

className: string = "JobScheduleUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobScheduleUpdateOptions

JobScheduleUpdateOptions: object

Additional parameters for update operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobScheduleUpdateOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobScheduleUpdateParameter

JobScheduleUpdateParameter: object

An interface representing JobScheduleUpdateParameter.

summary

The set of changes to be made to a job schedule.

jobSpecification

jobSpecification: JobSpecification

Details of the jobs to be created on this schedule. Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the job schedule as metadata. If you do not specify this element, it takes the default value of an empty list; in effect, any existing metadata is deleted.

schedule

schedule: Schedule

The schedule according to which jobs will be created. If you do not specify this element, it is equivalent to passing the default schedule: that is, a single job scheduled to run immediately.

serializedName

serializedName: string = "JobScheduleUpdateParameter"

type

type: object

className

className: string = "JobScheduleUpdateParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

jobSpecification

jobSpecification: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "jobSpecification"

type

type: object

className

className: string = "JobSpecification"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

schedule

schedule: object

required

required: true = true

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

Const JobSchedulingError

JobSchedulingError: object

An interface representing JobSchedulingError.

summary

An error encountered by the Batch service when scheduling a job.

category

category: ErrorCategory

The category of the job scheduling error. Possible values include: 'userError', 'serverError'

Optional code

code: undefined | string

An identifier for the job scheduling error. Codes are invariant and are intended to be consumed programmatically.

Optional details

details: NameValuePair[]

A list of additional error details related to the scheduling error.

Optional message

message: undefined | string

A message describing the job scheduling error, intended to be suitable for display in a user interface.

serializedName

serializedName: string = "JobSchedulingError"

type

type: object

className

className: string = "JobSchedulingError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

category

category: object

required

required: true = true

serializedName

serializedName: string = "category"

type

type: object

allowedValues

allowedValues: string[] = ["usererror","servererror"]

name

name: "Enum" = "Enum"

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const JobSpecification

JobSpecification: object

An interface representing JobSpecification.

summary

Specifies details of the jobs to be created on a schedule.

Optional commonEnvironmentSettings

commonEnvironmentSettings: EnvironmentSetting[]

A list of common environment variable settings. These environment variables are set for all tasks in jobs created under this schedule (including the Job Manager, Job Preparation and Job Release tasks). Individual tasks can override an environment setting specified here by specifying the same setting name with a different value.

Optional constraints

constraints: JobConstraints

The execution constraints for jobs created under this schedule.

Optional displayName

displayName: undefined | string

The display name for jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Optional jobManagerTask

jobManagerTask: JobManagerTask

The details of a Job Manager task to be launched when a job is started under this schedule. If the job does not specify a Job Manager task, the user must explicitly add tasks to the job using the Task API. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job.

Optional jobPreparationTask

jobPreparationTask: JobPreparationTask

The Job Preparation task for jobs created under this schedule. If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.

Optional jobReleaseTask

jobReleaseTask: JobReleaseTask

The Job Release task for jobs created under this schedule. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation. A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with each job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Optional networkConfiguration

networkConfiguration: JobNetworkConfiguration

The network configuration for the job.

Optional onAllTasksComplete

onAllTasksComplete: OnAllTasksComplete

The action the Batch service should take when all tasks in a job created under this schedule are in the completed state. Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'

Optional onTaskFailure

onTaskFailure: OnTaskFailure

The action the Batch service should take when any task fails in a job created under this schedule. A task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'

poolInfo

poolInfo: PoolInformation

The pool on which the Batch service runs the tasks of jobs created under this schedule.

Optional priority

priority: undefined | number

The priority of jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all jobs under the job schedule. You can update a job's priority after it has been created using by using the update job API.

Optional usesTaskDependencies

usesTaskDependencies: undefined | false | true

Whether tasks in the job can define dependencies on each other. The default is false.

serializedName

serializedName: string = "JobSpecification"

type

type: object

className

className: string = "JobSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commonEnvironmentSettings

commonEnvironmentSettings: object

serializedName

serializedName: string = "commonEnvironmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "JobConstraints"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

jobManagerTask

jobManagerTask: object

serializedName

serializedName: string = "jobManagerTask"

type

type: object

className

className: string = "JobManagerTask"

name

name: "Composite" = "Composite"

jobPreparationTask

jobPreparationTask: object

serializedName

serializedName: string = "jobPreparationTask"

type

type: object

className

className: string = "JobPreparationTask"

name

name: "Composite" = "Composite"

jobReleaseTask

jobReleaseTask: object

serializedName

serializedName: string = "jobReleaseTask"

type

type: object

className

className: string = "JobReleaseTask"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

networkConfiguration

networkConfiguration: object

serializedName

serializedName: string = "networkConfiguration"

type

type: object

className

className: string = "JobNetworkConfiguration"

name

name: "Composite" = "Composite"

onAllTasksComplete

onAllTasksComplete: object

serializedName

serializedName: string = "onAllTasksComplete"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","terminatejob"]

name

name: "Enum" = "Enum"

onTaskFailure

onTaskFailure: object

serializedName

serializedName: string = "onTaskFailure"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","performexitoptionsjobaction"]

name

name: "Enum" = "Enum"

poolInfo

poolInfo: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "poolInfo"

type

type: object

className

className: string = "PoolInformation"

name

name: "Composite" = "Composite"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

usesTaskDependencies

usesTaskDependencies: object

serializedName

serializedName: string = "usesTaskDependencies"

type

type: object

name

name: "Boolean" = "Boolean"

Const JobStatistics

JobStatistics: object

An interface representing JobStatistics.

summary

Resource usage statistics for a job.

kernelCPUTime

kernelCPUTime: string

The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job.

lastUpdateTime

lastUpdateTime: Date

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

numFailedTasks

numFailedTasks: number

The total number of tasks in the job that failed during the given time range. A task fails if it exhausts its maximum retry count without returning exit code 0.

numSucceededTasks

numSucceededTasks: number

The total number of tasks successfully completed in the job during the given time range. A task completes successfully if it returns exit code 0.

numTaskRetries

numTaskRetries: number

The total number of retries on all the tasks in the job during the given time range.

readIOGiB

readIOGiB: number

The total amount of data in GiB read from disk by all tasks in the job.

readIOps

readIOps: number

The total number of disk read operations made by all tasks in the job.

startTime

startTime: Date

The start time of the time range covered by the statistics.

url

url: string

The URL of the statistics.

userCPUTime

userCPUTime: string

The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job.

waitTime

waitTime: string

The total wait time of all tasks in the job. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.) This value is only reported in the account lifetime statistics; it is not included in the job statistics.

wallClockTime

wallClockTime: string

The total wall clock time of all tasks in the job. The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries.

writeIOGiB

writeIOGiB: number

The total amount of data in GiB written to disk by all tasks in the job.

writeIOps

writeIOps: number

The total number of disk write operations made by all tasks in the job.

serializedName

serializedName: string = "JobStatistics"

type

type: object

className

className: string = "JobStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kernelCPUTime

kernelCPUTime: object

required

required: true = true

serializedName

serializedName: string = "kernelCPUTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

lastUpdateTime

lastUpdateTime: object

required

required: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

numFailedTasks

numFailedTasks: object

required

required: true = true

serializedName

serializedName: string = "numFailedTasks"

type

type: object

name

name: "Number" = "Number"

numSucceededTasks

numSucceededTasks: object

required

required: true = true

serializedName

serializedName: string = "numSucceededTasks"

type

type: object

name

name: "Number" = "Number"

numTaskRetries

numTaskRetries: object

required

required: true = true

serializedName

serializedName: string = "numTaskRetries"

type

type: object

name

name: "Number" = "Number"

readIOGiB

readIOGiB: object

required

required: true = true

serializedName

serializedName: string = "readIOGiB"

type

type: object

name

name: "Number" = "Number"

readIOps

readIOps: object

required

required: true = true

serializedName

serializedName: string = "readIOps"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

url

url: object

required

required: true = true

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

userCPUTime

userCPUTime: object

required

required: true = true

serializedName

serializedName: string = "userCPUTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

waitTime

waitTime: object

required

required: true = true

serializedName

serializedName: string = "waitTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

wallClockTime

wallClockTime: object

required

required: true = true

serializedName

serializedName: string = "wallClockTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

writeIOGiB

writeIOGiB: object

required

required: true = true

serializedName

serializedName: string = "writeIOGiB"

type

type: object

name

name: "Number" = "Number"

writeIOps

writeIOps: object

required

required: true = true

serializedName

serializedName: string = "writeIOps"

type

type: object

name

name: "Number" = "Number"

Const JobTerminateHeaders

JobTerminateHeaders: object

Defines headers for Terminate operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-terminate-headers"

type

type: object

className

className: string = "JobTerminateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobTerminateOptions

JobTerminateOptions: object

Additional parameters for terminate operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobTerminateOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobTerminateParameter

JobTerminateParameter: object

An interface representing JobTerminateParameter.

summary

Options when terminating a job.

Optional terminateReason

terminateReason: undefined | string

The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'.

serializedName

serializedName: string = "JobTerminateParameter"

type

type: object

className

className: string = "JobTerminateParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

terminateReason

terminateReason: object

serializedName

serializedName: string = "terminateReason"

type

type: object

name

name: "String" = "String"

Const JobUpdateHeaders

JobUpdateHeaders: object

Defines headers for Update operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "job-update-headers"

type

type: object

className

className: string = "JobUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const JobUpdateOptions

JobUpdateOptions: object

Additional parameters for update operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "JobUpdateOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const JobUpdateParameter

JobUpdateParameter: object

An interface representing JobUpdateParameter.

summary

The set of changes to be made to a job.

Optional constraints

constraints: JobConstraints

The execution constraints for the job. If omitted, the constraints are cleared.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the job as metadata. If omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted.

Optional onAllTasksComplete

onAllTasksComplete: OnAllTasksComplete

The action the Batch service should take when all tasks in the job are in the completed state. If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob. Possible values include: 'noAction', 'terminateJob'

poolInfo

poolInfo: PoolInformation

The pool on which the Batch service runs the job's tasks. You may change the pool for a job only when the job is disabled. The Update Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job.

Optional priority

priority: undefined | number

The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0.

serializedName

serializedName: string = "JobUpdateParameter"

type

type: object

className

className: string = "JobUpdateParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "JobConstraints"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

onAllTasksComplete

onAllTasksComplete: object

serializedName

serializedName: string = "onAllTasksComplete"

type

type: object

allowedValues

allowedValues: string[] = ["noaction","terminatejob"]

name

name: "Enum" = "Enum"

poolInfo

poolInfo: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "poolInfo"

type

type: object

className

className: string = "PoolInformation"

name

name: "Composite" = "Composite"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

Const LinuxUserConfiguration

LinuxUserConfiguration: object

An interface representing LinuxUserConfiguration.

summary

Properties used to create a user account on a Linux node.

Optional gid

gid: undefined | number

The group ID for the user account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

Optional sshPrivateKey

sshPrivateKey: undefined | string

The SSH private key for the user account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

Optional uid

uid: undefined | number

The user ID of the user account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

serializedName

serializedName: string = "LinuxUserConfiguration"

type

type: object

className

className: string = "LinuxUserConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

gid

gid: object

serializedName

serializedName: string = "gid"

type

type: object

name

name: "Number" = "Number"

sshPrivateKey

sshPrivateKey: object

serializedName

serializedName: string = "sshPrivateKey"

type

type: object

name

name: "String" = "String"

uid

uid: object

serializedName

serializedName: string = "uid"

type

type: object

name

name: "Number" = "Number"

Const MetadataItem

MetadataItem: object

The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.

summary

A name-value pair associated with a Batch service resource.

name

name: string

The name of the metadata item.

value

value: string

The value of the metadata item.

serializedName

serializedName: string = "MetadataItem"

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const MultiInstanceSettings

MultiInstanceSettings: object

Multi-instance tasks are commonly used to support MPI tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance task fails. The multi-instance task is then terminated and retried, up to its retry limit.

summary

Settings which specify how to run a multi-instance task.

Optional commonResourceFiles

commonResourceFiles: ResourceFile[]

A list of files that the Batch service will download before running the coordination command line. The difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

coordinationCommandLine

coordinationCommandLine: string

The command line to run on all the compute nodes to enable them to coordinate when the primary runs the main task command. A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.

Optional numberOfInstances

numberOfInstances: undefined | number

The number of compute nodes required by the task. If omitted, the default is 1.

serializedName

serializedName: string = "MultiInstanceSettings"

type

type: object

className

className: string = "MultiInstanceSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commonResourceFiles

commonResourceFiles: object

serializedName

serializedName: string = "commonResourceFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

coordinationCommandLine

coordinationCommandLine: object

required

required: true = true

serializedName

serializedName: string = "coordinationCommandLine"

type

type: object

name

name: "String" = "String"

numberOfInstances

numberOfInstances: object

serializedName

serializedName: string = "numberOfInstances"

type

type: object

name

name: "Number" = "Number"

Const NameValuePair

NameValuePair: object

An interface representing NameValuePair.

summary

Represents a name-value pair.

Optional name

name: undefined | string

The name in the name-value pair.

Optional value

value: undefined | string

The value in the name-value pair.

serializedName

serializedName: string = "NameValuePair"

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const NetworkConfiguration

NetworkConfiguration: object

The network configuration for a pool.

Optional dynamicVNetAssignmentScope

dynamicVNetAssignmentScope: DynamicVNetAssignmentScope

The scope of dynamic vnet assignment. Possible values include: 'none', 'job'

Optional endpointConfiguration

endpointConfiguration: PoolEndpointConfiguration

The configuration for endpoints on compute nodes in the Batch pool. Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property.

Optional subnetId

subnetId: undefined | string

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. For pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. For more details, see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

serializedName

serializedName: string = "NetworkConfiguration"

type

type: object

className

className: string = "NetworkConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dynamicVNetAssignmentScope

dynamicVNetAssignmentScope: object

serializedName

serializedName: string = "dynamicVNetAssignmentScope"

type

type: object

allowedValues

allowedValues: string[] = ["none","job"]

name

name: "Enum" = "Enum"

endpointConfiguration

endpointConfiguration: object

serializedName

serializedName: string = "endpointConfiguration"

type

type: object

className

className: string = "PoolEndpointConfiguration"

name

name: "Composite" = "Composite"

subnetId

subnetId: object

serializedName

serializedName: string = "subnetId"

type

type: object

name

name: "String" = "String"

Const NetworkSecurityGroupRule

NetworkSecurityGroupRule: object

An interface representing NetworkSecurityGroupRule.

summary

A network security group rule to apply to an inbound endpoint.

access

The action that should be taken for a specified IP address, subnet range or tag. Possible values include: 'allow', 'deny'

priority

priority: number

The priority for this rule. Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 3500. If any reserved or duplicate values are provided the request fails with HTTP status code 400.

sourceAddressPrefix

sourceAddressPrefix: string

The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400.

serializedName

serializedName: string = "NetworkSecurityGroupRule"

type

type: object

className

className: string = "NetworkSecurityGroupRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

access

access: object

required

required: true = true

serializedName

serializedName: string = "access"

type

type: object

allowedValues

allowedValues: string[] = ["allow","deny"]

name

name: "Enum" = "Enum"

priority

priority: object

required

required: true = true

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

sourceAddressPrefix

sourceAddressPrefix: object

required

required: true = true

serializedName

serializedName: string = "sourceAddressPrefix"

type

type: object

name

name: "String" = "String"

Const NodeAgentInformation

NodeAgentInformation: object

The Batch node agent is a program that runs on each node in the pool and provides Batch capability on the compute node.

summary

Information about the node agent.

lastUpdateTime

lastUpdateTime: Date

The time when the node agent was updated on the compute node. This is the most recent time that the node agent was updated to a new version.

version

version: string

The version of the Batch node agent running on the compute node. This version number can be checked against the node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

serializedName

serializedName: string = "NodeAgentInformation"

type

type: object

className

className: string = "NodeAgentInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastUpdateTime

lastUpdateTime: object

required

required: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

version

version: object

required

required: true = true

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const NodeAgentSku

NodeAgentSku: object

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.

summary

A node agent SKU supported by the Batch service.

Optional id

id: undefined | string

The ID of the node agent SKU.

Optional osType

osType: OSType

The type of operating system (e.g. Windows or Linux) compatible with the node agent SKU. Possible values include: 'linux', 'windows'

Optional verifiedImageReferences

verifiedImageReferences: ImageReference[]

The list of Azure Marketplace images verified to be compatible with this node agent SKU. This collection is not exhaustive (the node agent may be compatible with other images).

serializedName

serializedName: string = "NodeAgentSku"

type

type: object

className

className: string = "NodeAgentSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

allowedValues

allowedValues: string[] = ["linux","windows"]

name

name: "Enum" = "Enum"

verifiedImageReferences

verifiedImageReferences: object

serializedName

serializedName: string = "verifiedImageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ImageReference"

name

name: "Composite" = "Composite"

Const NodeCounts

NodeCounts: object

An interface representing NodeCounts.

summary

The number of nodes in each node state.

creating

creating: number

The number of nodes in the creating state.

idle

idle: number

The number of nodes in the idle state.

leavingPool

leavingPool: number

The number of nodes in the leavingPool state.

offline

offline: number

The number of nodes in the offline state.

preempted

preempted: number

The number of nodes in the preempted state.

rebooting

rebooting: number

The count of nodes in the rebooting state.

reimaging

reimaging: number

The number of nodes in the reimaging state.

running

running: number

The number of nodes in the running state.

startTaskFailed

startTaskFailed: number

The number of nodes in the startTaskFailed state.

starting

starting: number

The number of nodes in the starting state.

total

total: number

The total number of nodes.

unknown

unknown: number

The number of nodes in the unknown state.

unusable

unusable: number

The number of nodes in the unusable state.

waitingForStartTask

waitingForStartTask: number

The number of nodes in the waitingForStartTask state.

serializedName

serializedName: string = "NodeCounts"

type

type: object

className

className: string = "NodeCounts"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

creating

creating: object

required

required: true = true

serializedName

serializedName: string = "creating"

type

type: object

name

name: "Number" = "Number"

idle

idle: object

required

required: true = true

serializedName

serializedName: string = "idle"

type

type: object

name

name: "Number" = "Number"

leavingPool

leavingPool: object

required

required: true = true

serializedName

serializedName: string = "leavingPool"

type

type: object

name

name: "Number" = "Number"

offline

offline: object

required

required: true = true

serializedName

serializedName: string = "offline"

type

type: object

name

name: "Number" = "Number"

preempted

preempted: object

required

required: true = true

serializedName

serializedName: string = "preempted"

type

type: object

name

name: "Number" = "Number"

rebooting

rebooting: object

required

required: true = true

serializedName

serializedName: string = "rebooting"

type

type: object

name

name: "Number" = "Number"

reimaging

reimaging: object

required

required: true = true

serializedName

serializedName: string = "reimaging"

type

type: object

name

name: "Number" = "Number"

running

running: object

required

required: true = true

serializedName

serializedName: string = "running"

type

type: object

name

name: "Number" = "Number"

startTaskFailed

startTaskFailed: object

required

required: true = true

serializedName

serializedName: string = "startTaskFailed"

type

type: object

name

name: "Number" = "Number"

starting

starting: object

required

required: true = true

serializedName

serializedName: string = "starting"

type

type: object

name

name: "Number" = "Number"

total

total: object

required

required: true = true

serializedName

serializedName: string = "total"

type

type: object

name

name: "Number" = "Number"

unknown

unknown: object

required

required: true = true

serializedName

serializedName: string = "unknown"

type

type: object

name

name: "Number" = "Number"

unusable

unusable: object

required

required: true = true

serializedName

serializedName: string = "unusable"

type

type: object

name

name: "Number" = "Number"

waitingForStartTask

waitingForStartTask: object

required

required: true = true

serializedName

serializedName: string = "waitingForStartTask"

type

type: object

name

name: "Number" = "Number"

Const NodeDisableSchedulingParameter

NodeDisableSchedulingParameter: object

An interface representing NodeDisableSchedulingParameter.

summary

Options for disabling scheduling on a compute node.

Optional nodeDisableSchedulingOption

nodeDisableSchedulingOption: DisableComputeNodeSchedulingOption

What to do with currently running tasks when disabling task scheduling on the compute node. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion'

serializedName

serializedName: string = "NodeDisableSchedulingParameter"

type

type: object

className

className: string = "NodeDisableSchedulingParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeDisableSchedulingOption

nodeDisableSchedulingOption: object

serializedName

serializedName: string = "nodeDisableSchedulingOption"

type

type: object

allowedValues

allowedValues: string[] = ["requeue","terminate","taskcompletion"]

name

name: "Enum" = "Enum"

Const NodeFile

NodeFile: object

An interface representing NodeFile.

summary

Information about a file or directory on a compute node.

Optional isDirectory

isDirectory: undefined | false | true

Whether the object represents a directory.

Optional name

name: undefined | string

The file path.

Optional properties

properties: FileProperties

The file properties.

Optional url

url: undefined | string

The URL of the file.

serializedName

serializedName: string = "NodeFile"

type

type: object

className

className: string = "NodeFile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isDirectory

isDirectory: object

serializedName

serializedName: string = "isDirectory"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "FileProperties"

name

name: "Composite" = "Composite"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const NodeFileListResult

NodeFileListResult: object
interface

An interface representing the NodeFileListResult.

summary

The result of listing the files on a compute node, or the files associated with a task on a node.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "NodeFileListResult"

__@iterator

  • __@iterator(): IterableIterator<NodeFile>
  • Iterator

    Returns IterableIterator<NodeFile>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<NodeFile>[]

      Additional items to add to the end of array1.

    Returns NodeFile[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns NodeFile[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, NodeFile]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, NodeFile]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: NodeFile, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: NodeFile

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): NodeFile[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns NodeFile[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): NodeFile | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns NodeFile | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: NodeFile, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: NodeFile

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: NodeFile, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: NodeFile

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: NodeFile, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: NodeFile

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns NodeFile | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: NodeFile[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): NodeFile
  • reduce(callbackfn: function, initialValue: NodeFile): NodeFile
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns NodeFile

  • Parameters

    Returns NodeFile

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NodeFile, currentIndex: number, array: NodeFile[]): U
        • Parameters

          • previousValue: U
          • currentValue: NodeFile
          • currentIndex: number
          • array: NodeFile[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): NodeFile
  • reduceRight(callbackfn: function, initialValue: NodeFile): NodeFile
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns NodeFile

  • Parameters

    Returns NodeFile

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: NodeFile, currentIndex: number, array: NodeFile[]): U
        • Parameters

          • previousValue: U
          • currentValue: NodeFile
          • currentIndex: number
          • array: NodeFile[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns NodeFile[]

shift

  • Removes the first element from an array and returns it.

    Returns NodeFile | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): NodeFile[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns NodeFile[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): NodeFile[]
  • splice(start: number, deleteCount: number, ...items: NodeFile[]): NodeFile[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns NodeFile[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: NodeFile[]

      Elements to insert into the array in place of the deleted elements.

    Returns NodeFile[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: NodeFile[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<NodeFile>

type

type: object

className

className: string = "NodeFileListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NodeFile"

name

name: "Composite" = "Composite"

Const NodeRebootParameter

NodeRebootParameter: object

An interface representing NodeRebootParameter.

summary

Options for rebooting a compute node.

Optional nodeRebootOption

nodeRebootOption: ComputeNodeRebootOption

When to reboot the compute node and what to do with currently running tasks. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

serializedName

serializedName: string = "NodeRebootParameter"

type

type: object

className

className: string = "NodeRebootParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeRebootOption

nodeRebootOption: object

serializedName

serializedName: string = "nodeRebootOption"

type

type: object

allowedValues

allowedValues: string[] = ["requeue","terminate","taskcompletion","retaineddata"]

name

name: "Enum" = "Enum"

Const NodeReimageParameter

NodeReimageParameter: object

An interface representing NodeReimageParameter.

summary

Options for reimaging a compute node.

Optional nodeReimageOption

nodeReimageOption: ComputeNodeReimageOption

When to reimage the compute node and what to do with currently running tasks. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

serializedName

serializedName: string = "NodeReimageParameter"

type

type: object

className

className: string = "NodeReimageParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeReimageOption

nodeReimageOption: object

serializedName

serializedName: string = "nodeReimageOption"

type

type: object

allowedValues

allowedValues: string[] = ["requeue","terminate","taskcompletion","retaineddata"]

name

name: "Enum" = "Enum"

Const NodeRemoveParameter

NodeRemoveParameter: object

An interface representing NodeRemoveParameter.

summary

Options for removing compute nodes from a pool.

Optional nodeDeallocationOption

nodeDeallocationOption: ComputeNodeDeallocationOption

Determines what to do with a node and its running task(s) after it has been selected for deallocation. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

nodeList

nodeList: string[]

A list containing the IDs of the compute nodes to be removed from the specified pool.

Optional resizeTimeout

resizeTimeout: undefined | string

The timeout for removal of compute nodes to the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

serializedName

serializedName: string = "NodeRemoveParameter"

type

type: object

className

className: string = "NodeRemoveParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeDeallocationOption

nodeDeallocationOption: object

serializedName

serializedName: string = "nodeDeallocationOption"

type

type: object

allowedValues

allowedValues: string[] = ["requeue","terminate","taskcompletion","retaineddata"]

name

name: "Enum" = "Enum"

nodeList

nodeList: object

required

required: true = true

serializedName

serializedName: string = "nodeList"

constraints

constraints: object

MaxItems

MaxItems: number = 100

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

resizeTimeout

resizeTimeout: object

serializedName

serializedName: string = "resizeTimeout"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const NodeUpdateUserParameter

NodeUpdateUserParameter: object

An interface representing NodeUpdateUserParameter.

summary

The set of changes to be made to a user account on a node.

Optional expiryTime

expiryTime: Date

The time at which the account should expire. If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day.

Optional password

password: undefined | string

The password of the account. The password is required for Windows nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.

Optional sshPublicKey

sshPublicKey: undefined | string

The SSH public key that can be used for remote login to the compute node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed.

serializedName

serializedName: string = "NodeUpdateUserParameter"

type

type: object

className

className: string = "NodeUpdateUserParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryTime

expiryTime: object

serializedName

serializedName: string = "expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

password

password: object

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

sshPublicKey

sshPublicKey: object

serializedName

serializedName: string = "sshPublicKey"

type

type: object

name

name: "String" = "String"

Const OutputFile

OutputFile: object

An interface representing OutputFile.

summary

A specification for uploading files from an Azure Batch node to another location after the Batch service has finished executing the task process.

destination

The destination for the output file(s).

filePattern

filePattern: string

A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths are relative to the task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), * matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but ..gif will). A simple example: *\.txt matches any file that does not start in '.' and ends with .txt in the task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[] would match a file named abc). Note that both \ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied.

uploadOptions

Additional options for the upload operation, including under what conditions to perform the upload.

serializedName

serializedName: string = "OutputFile"

type

type: object

className

className: string = "OutputFile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destination

destination: object

required

required: true = true

serializedName

serializedName: string = "destination"

type

type: object

className

className: string = "OutputFileDestination"

name

name: "Composite" = "Composite"

filePattern

filePattern: object

required

required: true = true

serializedName

serializedName: string = "filePattern"

type

type: object

name

name: "String" = "String"

uploadOptions

uploadOptions: object

required

required: true = true

serializedName

serializedName: string = "uploadOptions"

type

type: object

className

className: string = "OutputFileUploadOptions"

name

name: "Composite" = "Composite"

Const OutputFileBlobContainerDestination

OutputFileBlobContainerDestination: object

An interface representing OutputFileBlobContainerDestination.

summary

Specifies a file upload destination within an Azure blob storage container.

containerUrl

containerUrl: string

The URL of the container within Azure Blob Storage to which to upload the file(s). The URL must include a Shared Access Signature (SAS) granting write permissions to the container.

Optional path

path: undefined | string

The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name.

serializedName

serializedName: string = "OutputFileBlobContainerDestination"

type

type: object

className

className: string = "OutputFileBlobContainerDestination"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerUrl

containerUrl: object

required

required: true = true

serializedName

serializedName: string = "containerUrl"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

Const OutputFileDestination

OutputFileDestination: object

An interface representing OutputFileDestination.

summary

The destination to which a file should be uploaded.

Optional container

A location in Azure blob storage to which files are uploaded.

serializedName

serializedName: string = "OutputFileDestination"

type

type: object

className

className: string = "OutputFileDestination"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

container

container: object

serializedName

serializedName: string = "container"

type

type: object

className

className: string = "OutputFileBlobContainerDestination"

name

name: "Composite" = "Composite"

Const OutputFileUploadOptions

OutputFileUploadOptions: object

An interface representing OutputFileUploadOptions.

summary

Details about an output file upload operation, including under what conditions to perform the upload.

uploadCondition

uploadCondition: OutputFileUploadCondition

The conditions under which the task output file or set of files should be uploaded. The default is taskcompletion. Possible values include: 'taskSuccess', 'taskFailure', 'taskCompletion'

serializedName

serializedName: string = "OutputFileUploadOptions"

type

type: object

className

className: string = "OutputFileUploadOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

uploadCondition

uploadCondition: object

required

required: true = true

serializedName

serializedName: string = "uploadCondition"

type

type: object

allowedValues

allowedValues: string[] = ["tasksuccess","taskfailure","taskcompletion"]

name

name: "Enum" = "Enum"

Const PoolAddHeaders

PoolAddHeaders: object

Defines headers for Add operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-add-headers"

type

type: object

className

className: string = "PoolAddHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolAddOptions

PoolAddOptions: object

Additional parameters for add operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolAddOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolAddParameter

PoolAddParameter: object

An interface representing PoolAddParameter.

summary

A pool in the Azure Batch service to add.

Optional applicationLicenses

applicationLicenses: string[]

The list of application licenses the Batch service will make available on each compute node in the pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.

Optional applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

The list of application packages to be installed on each compute node in the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

Optional autoScaleEvaluationInterval

autoScaleEvaluationInterval: undefined | string

The time interval at which to automatically adjust the pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional autoScaleFormula

autoScaleFormula: undefined | string

A formula for the desired number of compute nodes in the pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale compute nodes in an Azure Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

Optional certificateReferences

certificateReferences: CertificateReference[]

The list of certificates to be installed on each compute node in the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

Optional cloudServiceConfiguration

cloudServiceConfiguration: CloudServiceConfiguration

The cloud service configuration for the pool. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

Optional displayName

displayName: undefined | string

The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Optional enableAutoScale

enableAutoScale: undefined | false | true

Whether the pool size should automatically adjust over time. If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.

Optional enableInterNodeCommunication

enableInterNodeCommunication: undefined | false | true

Whether the pool permits direct communication between nodes. Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.

id

id: string

A string that uniquely identifies the pool within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two pool IDs within an account that differ only by case).

Optional maxTasksPerNode

maxTasksPerNode: undefined | number

The maximum number of tasks that can run concurrently on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Optional networkConfiguration

networkConfiguration: NetworkConfiguration

The network configuration for the pool.

Optional resizeTimeout

resizeTimeout: undefined | string

The timeout for allocation of compute nodes to the pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional startTask

startTask: StartTask

A task specified to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.

Optional targetDedicatedNodes

targetDedicatedNodes: undefined | number

The desired number of dedicated compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Optional targetLowPriorityNodes

targetLowPriorityNodes: undefined | number

The desired number of low-priority compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Optional taskSchedulingPolicy

taskSchedulingPolicy: TaskSchedulingPolicy

How tasks are distributed across compute nodes in a pool. If not specified, the default is spread.

Optional userAccounts

userAccounts: UserAccount[]

The list of user accounts to be created on each node in the pool.

Optional virtualMachineConfiguration

virtualMachineConfiguration: VirtualMachineConfiguration

The virtual machine configuration for the pool. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.

vmSize

vmSize: string

The size of virtual machines in the pool. All virtual machines in a pool are the same size. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

serializedName

serializedName: string = "PoolAddParameter"

type

type: object

className

className: string = "PoolAddParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationLicenses

applicationLicenses: object

serializedName

serializedName: string = "applicationLicenses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

applicationPackageReferences

applicationPackageReferences: object

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

autoScaleEvaluationInterval

autoScaleEvaluationInterval: object

serializedName

serializedName: string = "autoScaleEvaluationInterval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

autoScaleFormula

autoScaleFormula: object

serializedName

serializedName: string = "autoScaleFormula"

type

type: object

name

name: "String" = "String"

certificateReferences

certificateReferences: object

serializedName

serializedName: string = "certificateReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateReference"

name

name: "Composite" = "Composite"

cloudServiceConfiguration

cloudServiceConfiguration: object

serializedName

serializedName: string = "cloudServiceConfiguration"

type

type: object

className

className: string = "CloudServiceConfiguration"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

enableAutoScale

enableAutoScale: object

serializedName

serializedName: string = "enableAutoScale"

type

type: object

name

name: "Boolean" = "Boolean"

enableInterNodeCommunication

enableInterNodeCommunication: object

serializedName

serializedName: string = "enableInterNodeCommunication"

type

type: object

name

name: "Boolean" = "Boolean"

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

maxTasksPerNode

maxTasksPerNode: object

serializedName

serializedName: string = "maxTasksPerNode"

type

type: object

name

name: "Number" = "Number"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

networkConfiguration

networkConfiguration: object

serializedName

serializedName: string = "networkConfiguration"

type

type: object

className

className: string = "NetworkConfiguration"

name

name: "Composite" = "Composite"

resizeTimeout

resizeTimeout: object

serializedName

serializedName: string = "resizeTimeout"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

startTask

startTask: object

serializedName

serializedName: string = "startTask"

type

type: object

className

className: string = "StartTask"

name

name: "Composite" = "Composite"

targetDedicatedNodes

targetDedicatedNodes: object

serializedName

serializedName: string = "targetDedicatedNodes"

type

type: object

name

name: "Number" = "Number"

targetLowPriorityNodes

targetLowPriorityNodes: object

serializedName

serializedName: string = "targetLowPriorityNodes"

type

type: object

name

name: "Number" = "Number"

taskSchedulingPolicy

taskSchedulingPolicy: object

serializedName

serializedName: string = "taskSchedulingPolicy"

type

type: object

className

className: string = "TaskSchedulingPolicy"

name

name: "Composite" = "Composite"

userAccounts

userAccounts: object

serializedName

serializedName: string = "userAccounts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserAccount"

name

name: "Composite" = "Composite"

virtualMachineConfiguration

virtualMachineConfiguration: object

serializedName

serializedName: string = "virtualMachineConfiguration"

type

type: object

className

className: string = "VirtualMachineConfiguration"

name

name: "Composite" = "Composite"

vmSize

vmSize: object

required

required: true = true

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const PoolDeleteHeaders

PoolDeleteHeaders: object

Defines headers for Delete operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-delete-headers"

type

type: object

className

className: string = "PoolDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const PoolDeleteMethodOptions

PoolDeleteMethodOptions: object

Additional parameters for deleteMethod operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolDeleteMethodOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolDisableAutoScaleHeaders

PoolDisableAutoScaleHeaders: object

Defines headers for DisableAutoScale operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-disableautoscale-headers"

type

type: object

className

className: string = "PoolDisableAutoScaleHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolDisableAutoScaleOptions

PoolDisableAutoScaleOptions: object

Additional parameters for disableAutoScale operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolDisableAutoScaleOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolEnableAutoScaleHeaders

PoolEnableAutoScaleHeaders: object

Defines headers for EnableAutoScale operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-enableautoscale-headers"

type

type: object

className

className: string = "PoolEnableAutoScaleHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolEnableAutoScaleOptions

PoolEnableAutoScaleOptions: object

Additional parameters for enableAutoScale operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolEnableAutoScaleOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolEnableAutoScaleParameter

PoolEnableAutoScaleParameter: object

An interface representing PoolEnableAutoScaleParameter.

summary

Options for enabling automatic scaling on a pool.

Optional autoScaleEvaluationInterval

autoScaleEvaluationInterval: undefined | string

The time interval at which to automatically adjust the pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued.

Optional autoScaleFormula

autoScaleFormula: undefined | string

The formula for the desired number of compute nodes in the pool. The formula is checked for validity before it is applied to the pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

serializedName

serializedName: string = "PoolEnableAutoScaleParameter"

type

type: object

className

className: string = "PoolEnableAutoScaleParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoScaleEvaluationInterval

autoScaleEvaluationInterval: object

serializedName

serializedName: string = "autoScaleEvaluationInterval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

autoScaleFormula

autoScaleFormula: object

serializedName

serializedName: string = "autoScaleFormula"

type

type: object

name

name: "String" = "String"

Const PoolEndpointConfiguration

PoolEndpointConfiguration: object

An interface representing PoolEndpointConfiguration.

summary

The endpoint configuration for a pool.

inboundNATPools

inboundNATPools: InboundNATPool[]

A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400.

serializedName

serializedName: string = "PoolEndpointConfiguration"

type

type: object

className

className: string = "PoolEndpointConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inboundNATPools

inboundNATPools: object

required

required: true = true

serializedName

serializedName: string = "inboundNATPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "InboundNATPool"

name

name: "Composite" = "Composite"

Const PoolEvaluateAutoScaleHeaders

PoolEvaluateAutoScaleHeaders: object

Defines headers for EvaluateAutoScale operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-evaluateautoscale-headers"

type

type: object

className

className: string = "PoolEvaluateAutoScaleHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolEvaluateAutoScaleOptions

PoolEvaluateAutoScaleOptions: object

Additional parameters for evaluateAutoScale operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolEvaluateAutoScaleOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolEvaluateAutoScaleParameter

PoolEvaluateAutoScaleParameter: object

An interface representing PoolEvaluateAutoScaleParameter.

summary

Options for evaluating an automatic scaling formula on a pool.

autoScaleFormula

autoScaleFormula: string

The formula for the desired number of compute nodes in the pool. The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

serializedName

serializedName: string = "PoolEvaluateAutoScaleParameter"

type

type: object

className

className: string = "PoolEvaluateAutoScaleParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoScaleFormula

autoScaleFormula: object

required

required: true = true

serializedName

serializedName: string = "autoScaleFormula"

type

type: object

name

name: "String" = "String"

Const PoolExistsHeaders

PoolExistsHeaders: object

Defines headers for Exists operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-exists-headers"

type

type: object

className

className: string = "PoolExistsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolExistsOptions

PoolExistsOptions: object

Additional parameters for exists operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolExistsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolGetAllLifetimeStatisticsHeaders

PoolGetAllLifetimeStatisticsHeaders: object

Defines headers for GetAllLifetimeStatistics operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-getalllifetimestatistics-headers"

type

type: object

className

className: string = "PoolGetAllLifetimeStatisticsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolGetAllLifetimeStatisticsOptions

PoolGetAllLifetimeStatisticsOptions: object

Additional parameters for getAllLifetimeStatistics operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolGetAllLifetimeStatisticsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolGetHeaders

PoolGetHeaders: object

Defines headers for Get operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTagHeader

eTagHeader: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModifiedHeader

lastModifiedHeader: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-get-headers"

type

type: object

className

className: string = "PoolGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTagHeader

eTagHeader: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModifiedHeader

lastModifiedHeader: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolGetOptions

PoolGetOptions: object

Additional parameters for get operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolGetOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolInformation

PoolInformation: object

An interface representing PoolInformation.

summary

Specifies how a job should be assigned to a pool.

Optional autoPoolSpecification

autoPoolSpecification: AutoPoolSpecification

Characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when the job is submitted. If auto pool creation fails, the Batch service moves the job to a completed state, and the pool creation error is set in the job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto pool. Any user actions that affect the lifetime of the auto pool while the job is active will result in unexpected behavior. You must specify either the pool ID or the auto pool specification, but not both.

Optional poolId

poolId: undefined | string

The ID of an existing pool. All the tasks of the job will run on the specified pool. You must ensure that the pool referenced by this property exists. If the pool does not exist at the time the Batch service tries to schedule a job, no tasks for the job will run until you create a pool with that id. Note that the Batch service will not reject the job request; it will simply not run tasks until the pool exists. You must specify either the pool ID or the auto pool specification, but not both.

serializedName

serializedName: string = "PoolInformation"

type

type: object

className

className: string = "PoolInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoPoolSpecification

autoPoolSpecification: object

serializedName

serializedName: string = "autoPoolSpecification"

type

type: object

className

className: string = "AutoPoolSpecification"

name

name: "Composite" = "Composite"

poolId

poolId: object

serializedName

serializedName: string = "poolId"

type

type: object

name

name: "String" = "String"

Const PoolListHeaders

PoolListHeaders: object

Defines headers for List operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-list-headers"

type

type: object

className

className: string = "PoolListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolListNextOptions

PoolListNextOptions: object

Additional parameters for listNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "PoolListNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const PoolListOptions

PoolListOptions: object

Additional parameters for list operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 pools can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolListOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolListUsageMetricsHeaders

PoolListUsageMetricsHeaders: object

Defines headers for ListUsageMetrics operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-listusagemetrics-headers"

type

type: object

className

className: string = "PoolListUsageMetricsHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolListUsageMetricsNextOptions

PoolListUsageMetricsNextOptions: object

Additional parameters for listUsageMetricsNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "PoolListUsageMetricsNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const PoolListUsageMetricsOptions

PoolListUsageMetricsOptions: object

Additional parameters for listUsageMetrics operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional endTime

endTime: Date

The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 results will be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional startTime

startTime: Date

The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolListUsageMetricsOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

endTime

endTime: object

type

type: object

name

name: "DateTime" = "DateTime"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

startTime

startTime: object

type

type: object

name

name: "DateTime" = "DateTime"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolListUsageMetricsResult

PoolListUsageMetricsResult: object
interface

An interface representing the PoolListUsageMetricsResult.

summary

The result of a listing the usage metrics for an account.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "PoolListUsageMetricsResult"

__@iterator

  • Iterator

    Returns IterableIterator<PoolUsageMetrics>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PoolUsageMetrics>[]

      Additional items to add to the end of array1.

    Returns PoolUsageMetrics[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PoolUsageMetrics[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PoolUsageMetrics]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PoolUsageMetrics, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PoolUsageMetrics

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PoolUsageMetrics[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PoolUsageMetrics[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PoolUsageMetrics | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns PoolUsageMetrics | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PoolUsageMetrics, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PoolUsageMetrics

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PoolUsageMetrics, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PoolUsageMetrics

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PoolUsageMetrics, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PoolUsageMetrics

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns PoolUsageMetrics | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PoolUsageMetrics

  • Parameters

    Returns PoolUsageMetrics

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PoolUsageMetrics

  • Parameters

    Returns PoolUsageMetrics

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns PoolUsageMetrics[]

shift

  • Removes the first element from an array and returns it.

    Returns PoolUsageMetrics | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PoolUsageMetrics[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PoolUsageMetrics[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PoolUsageMetrics[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PoolUsageMetrics[]

      Elements to insert into the array in place of the deleted elements.

    Returns PoolUsageMetrics[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PoolUsageMetrics[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<PoolUsageMetrics>

type

type: object

className

className: string = "PoolListUsageMetricsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PoolUsageMetrics"

name

name: "Composite" = "Composite"

Const PoolNodeCounts

PoolNodeCounts: object

An interface representing PoolNodeCounts.

summary

The number of nodes in each state for a pool.

Optional dedicated

dedicated: NodeCounts

The number of dedicated nodes in each state.

Optional lowPriority

lowPriority: NodeCounts

The number of low priority nodes in each state.

poolId

poolId: string

The ID of the pool.

serializedName

serializedName: string = "PoolNodeCounts"

type

type: object

className

className: string = "PoolNodeCounts"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dedicated

dedicated: object

serializedName

serializedName: string = "dedicated"

type

type: object

className

className: string = "NodeCounts"

name

name: "Composite" = "Composite"

lowPriority

lowPriority: object

serializedName

serializedName: string = "lowPriority"

type

type: object

className

className: string = "NodeCounts"

name

name: "Composite" = "Composite"

poolId

poolId: object

required

required: true = true

serializedName

serializedName: string = "poolId"

type

type: object

name

name: "String" = "String"

Const PoolNodeCountsListResult

PoolNodeCountsListResult: object
interface

An interface representing the PoolNodeCountsListResult.

summary

The result of listing the node counts in the account.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional odatanextLink

odatanextLink: undefined | string

serializedName

serializedName: string = "PoolNodeCountsListResult"

__@iterator

  • Iterator

    Returns IterableIterator<PoolNodeCounts>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PoolNodeCounts>[]

      Additional items to add to the end of array1.

    Returns PoolNodeCounts[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PoolNodeCounts[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PoolNodeCounts]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PoolNodeCounts, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PoolNodeCounts

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PoolNodeCounts[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PoolNodeCounts[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PoolNodeCounts | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns PoolNodeCounts | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PoolNodeCounts, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PoolNodeCounts

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PoolNodeCounts, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PoolNodeCounts

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PoolNodeCounts, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PoolNodeCounts

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns PoolNodeCounts | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PoolNodeCounts

  • Parameters

    Returns PoolNodeCounts

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PoolNodeCounts

  • Parameters

    Returns PoolNodeCounts

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns PoolNodeCounts[]

shift

  • Removes the first element from an array and returns it.

    Returns PoolNodeCounts | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PoolNodeCounts[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PoolNodeCounts[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PoolNodeCounts[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PoolNodeCounts[]

      Elements to insert into the array in place of the deleted elements.

    Returns PoolNodeCounts[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PoolNodeCounts[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<PoolNodeCounts>

type

type: object

className

className: string = "PoolNodeCountsListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

odatanextLink

odatanextLink: object

serializedName

serializedName: string = "odata\.nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PoolNodeCounts"

name

name: "Composite" = "Composite"

Const PoolPatchHeaders

PoolPatchHeaders: object

Defines headers for Patch operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-patch-headers"

type

type: object

className

className: string = "PoolPatchHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolPatchOptions

PoolPatchOptions: object

Additional parameters for patch operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolPatchOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolPatchParameter

PoolPatchParameter: object

An interface representing PoolPatchParameter.

summary

The set of changes to be made to a pool.

Optional applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

The list of application packages to be installed on each compute node in the pool. The list replaces any existing application package references on the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. If omitted, any existing application package references are left unchanged.

Optional certificateReferences

certificateReferences: CertificateReference[]

A list of certificates to be installed on each compute node in the pool. If this element is present, it replaces any existing certificate references configured on the pool. If omitted, any existing certificate references are left unchanged. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the pool as metadata. If this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged.

Optional startTask

startTask: StartTask

A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted. If this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged.

serializedName

serializedName: string = "PoolPatchParameter"

type

type: object

className

className: string = "PoolPatchParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationPackageReferences

applicationPackageReferences: object

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

certificateReferences

certificateReferences: object

serializedName

serializedName: string = "certificateReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateReference"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

startTask

startTask: object

serializedName

serializedName: string = "startTask"

type

type: object

className

className: string = "StartTask"

name

name: "Composite" = "Composite"

Const PoolRemoveNodesHeaders

PoolRemoveNodesHeaders: object

Defines headers for RemoveNodes operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-removenodes-headers"

type

type: object

className

className: string = "PoolRemoveNodesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolRemoveNodesOptions

PoolRemoveNodesOptions: object

Additional parameters for removeNodes operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolRemoveNodesOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolResizeHeaders

PoolResizeHeaders: object

Defines headers for Resize operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-resize-headers"

type

type: object

className

className: string = "PoolResizeHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolResizeOptions

PoolResizeOptions: object

Additional parameters for resize operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolResizeOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolResizeParameter

PoolResizeParameter: object

An interface representing PoolResizeParameter.

summary

Options for changing the size of a pool.

Optional nodeDeallocationOption

nodeDeallocationOption: ComputeNodeDeallocationOption

Determines what to do with a node and its running task(s) if the pool size is decreasing. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

Optional resizeTimeout

resizeTimeout: undefined | string

The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional targetDedicatedNodes

targetDedicatedNodes: undefined | number

The desired number of dedicated compute nodes in the pool.

Optional targetLowPriorityNodes

targetLowPriorityNodes: undefined | number

The desired number of low-priority compute nodes in the pool.

serializedName

serializedName: string = "PoolResizeParameter"

type

type: object

className

className: string = "PoolResizeParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeDeallocationOption

nodeDeallocationOption: object

serializedName

serializedName: string = "nodeDeallocationOption"

type

type: object

allowedValues

allowedValues: string[] = ["requeue","terminate","taskcompletion","retaineddata"]

name

name: "Enum" = "Enum"

resizeTimeout

resizeTimeout: object

serializedName

serializedName: string = "resizeTimeout"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

targetDedicatedNodes

targetDedicatedNodes: object

serializedName

serializedName: string = "targetDedicatedNodes"

type

type: object

name

name: "Number" = "Number"

targetLowPriorityNodes

targetLowPriorityNodes: object

serializedName

serializedName: string = "targetLowPriorityNodes"

type

type: object

name

name: "Number" = "Number"

Const PoolSpecification

PoolSpecification: object

An interface representing PoolSpecification.

summary

Specification for creating a new pool.

Optional applicationLicenses

applicationLicenses: string[]

The list of application licenses the Batch service will make available on each compute node in the pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail. The permitted licenses available on the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the pool.

Optional applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

The list of application packages to be installed on each compute node in the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.

Optional autoScaleEvaluationInterval

autoScaleEvaluationInterval: undefined | string

The time interval at which to automatically adjust the pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional autoScaleFormula

autoScaleFormula: undefined | string

The formula for the desired number of compute nodes in the pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information.

Optional certificateReferences

certificateReferences: CertificateReference[]

A list of certificates to be installed on each compute node in the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

Optional cloudServiceConfiguration

cloudServiceConfiguration: CloudServiceConfiguration

The cloud service configuration for the pool. This property must be specified if the pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'.

Optional displayName

displayName: undefined | string

The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Optional enableAutoScale

enableAutoScale: undefined | false | true

Whether the pool size should automatically adjust over time. If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The pool automatically resizes according to the formula. The default value is false.

Optional enableInterNodeCommunication

enableInterNodeCommunication: undefined | false | true

Whether the pool permits direct communication between nodes. Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.

Optional maxTasksPerNode

maxTasksPerNode: undefined | number

The maximum number of tasks that can run concurrently on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.

Optional metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

Optional networkConfiguration

networkConfiguration: NetworkConfiguration

The network configuration for the pool.

Optional resizeTimeout

resizeTimeout: undefined | string

The timeout for allocation of compute nodes to the pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional startTask

startTask: StartTask

A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.

Optional targetDedicatedNodes

targetDedicatedNodes: undefined | number

The desired number of dedicated compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Optional targetLowPriorityNodes

targetLowPriorityNodes: undefined | number

The desired number of low-priority compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.

Optional taskSchedulingPolicy

taskSchedulingPolicy: TaskSchedulingPolicy

How tasks are distributed across compute nodes in a pool. If not specified, the default is spread.

Optional userAccounts

userAccounts: UserAccount[]

The list of user accounts to be created on each node in the pool.

Optional virtualMachineConfiguration

virtualMachineConfiguration: VirtualMachineConfiguration

The virtual machine configuration for the pool. This property must be specified if the pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

vmSize

vmSize: string

The size of the virtual machines in the pool. All virtual machines in a pool are the same size. For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

serializedName

serializedName: string = "PoolSpecification"

type

type: object

className

className: string = "PoolSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationLicenses

applicationLicenses: object

serializedName

serializedName: string = "applicationLicenses"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

applicationPackageReferences

applicationPackageReferences: object

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

autoScaleEvaluationInterval

autoScaleEvaluationInterval: object

serializedName

serializedName: string = "autoScaleEvaluationInterval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

autoScaleFormula

autoScaleFormula: object

serializedName

serializedName: string = "autoScaleFormula"

type

type: object

name

name: "String" = "String"

certificateReferences

certificateReferences: object

serializedName

serializedName: string = "certificateReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateReference"

name

name: "Composite" = "Composite"

cloudServiceConfiguration

cloudServiceConfiguration: object

serializedName

serializedName: string = "cloudServiceConfiguration"

type

type: object

className

className: string = "CloudServiceConfiguration"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

enableAutoScale

enableAutoScale: object

serializedName

serializedName: string = "enableAutoScale"

type

type: object

name

name: "Boolean" = "Boolean"

enableInterNodeCommunication

enableInterNodeCommunication: object

serializedName

serializedName: string = "enableInterNodeCommunication"

type

type: object

name

name: "Boolean" = "Boolean"

maxTasksPerNode

maxTasksPerNode: object

serializedName

serializedName: string = "maxTasksPerNode"

type

type: object

name

name: "Number" = "Number"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

networkConfiguration

networkConfiguration: object

serializedName

serializedName: string = "networkConfiguration"

type

type: object

className

className: string = "NetworkConfiguration"

name

name: "Composite" = "Composite"

resizeTimeout

resizeTimeout: object

serializedName

serializedName: string = "resizeTimeout"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

startTask

startTask: object

serializedName

serializedName: string = "startTask"

type

type: object

className

className: string = "StartTask"

name

name: "Composite" = "Composite"

targetDedicatedNodes

targetDedicatedNodes: object

serializedName

serializedName: string = "targetDedicatedNodes"

type

type: object

name

name: "Number" = "Number"

targetLowPriorityNodes

targetLowPriorityNodes: object

serializedName

serializedName: string = "targetLowPriorityNodes"

type

type: object

name

name: "Number" = "Number"

taskSchedulingPolicy

taskSchedulingPolicy: object

serializedName

serializedName: string = "taskSchedulingPolicy"

type

type: object

className

className: string = "TaskSchedulingPolicy"

name

name: "Composite" = "Composite"

userAccounts

userAccounts: object

serializedName

serializedName: string = "userAccounts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserAccount"

name

name: "Composite" = "Composite"

virtualMachineConfiguration

virtualMachineConfiguration: object

serializedName

serializedName: string = "virtualMachineConfiguration"

type

type: object

className

className: string = "VirtualMachineConfiguration"

name

name: "Composite" = "Composite"

vmSize

vmSize: object

required

required: true = true

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const PoolStatistics

PoolStatistics: object

An interface representing PoolStatistics.

summary

Contains utilization and resource usage statistics for the lifetime of a pool.

lastUpdateTime

lastUpdateTime: Date

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

Optional resourceStats

resourceStats: ResourceStatistics

Statistics related to resource consumption by compute nodes in the pool.

startTime

startTime: Date

The start time of the time range covered by the statistics.

url

url: string

The URL for the statistics.

Optional usageStats

usageStats: UsageStatistics

Statistics related to pool usage, such as the amount of core-time used.

serializedName

serializedName: string = "PoolStatistics"

type

type: object

className

className: string = "PoolStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastUpdateTime

lastUpdateTime: object

required

required: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

resourceStats

resourceStats: object

serializedName

serializedName: string = "resourceStats"

type

type: object

className

className: string = "ResourceStatistics"

name

name: "Composite" = "Composite"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

url

url: object

required

required: true = true

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

usageStats

usageStats: object

serializedName

serializedName: string = "usageStats"

type

type: object

className

className: string = "UsageStatistics"

name

name: "Composite" = "Composite"

Const PoolStopResizeHeaders

PoolStopResizeHeaders: object

Defines headers for StopResize operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-stopresize-headers"

type

type: object

className

className: string = "PoolStopResizeHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolStopResizeOptions

PoolStopResizeOptions: object

Additional parameters for stopResize operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolStopResizeOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolUpdatePropertiesHeaders

PoolUpdatePropertiesHeaders: object

Defines headers for UpdateProperties operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "pool-updateproperties-headers"

type

type: object

className

className: string = "PoolUpdatePropertiesHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const PoolUpdatePropertiesOptions

PoolUpdatePropertiesOptions: object

Additional parameters for updateProperties operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "PoolUpdatePropertiesOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const PoolUpdatePropertiesParameter

PoolUpdatePropertiesParameter: object

An interface representing PoolUpdatePropertiesParameter.

summary

The set of changes to be made to a pool.

applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

The list of application packages to be installed on each compute node in the pool. The list replaces any existing application package references on the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. If omitted, or if you specify an empty collection, any existing application packages references are removed from the pool.

certificateReferences

certificateReferences: CertificateReference[]

A list of certificates to be installed on each compute node in the pool. This list replaces any existing certificate references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.

metadata

metadata: MetadataItem[]

A list of name-value pairs associated with the pool as metadata. This list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool.

Optional startTask

startTask: StartTask

A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted. If this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool.

serializedName

serializedName: string = "PoolUpdatePropertiesParameter"

type

type: object

className

className: string = "PoolUpdatePropertiesParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationPackageReferences

applicationPackageReferences: object

required

required: true = true

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

certificateReferences

certificateReferences: object

required

required: true = true

serializedName

serializedName: string = "certificateReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CertificateReference"

name

name: "Composite" = "Composite"

metadata

metadata: object

required

required: true = true

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetadataItem"

name

name: "Composite" = "Composite"

startTask

startTask: object

serializedName

serializedName: string = "startTask"

type

type: object

className

className: string = "StartTask"

name

name: "Composite" = "Composite"

Const PoolUsageMetrics

PoolUsageMetrics: object

An interface representing PoolUsageMetrics.

summary

Usage metrics for a pool across an aggregation interval.

endTime

endTime: Date

The end time of the aggregation interval covered by this entry.

poolId

poolId: string

The ID of the pool whose metrics are aggregated in this entry.

startTime

startTime: Date

The start time of the aggregation interval covered by this entry.

totalCoreHours

totalCoreHours: number

The total core hours used in the pool during this aggregation interval.

vmSize

vmSize: string

The size of virtual machines in the pool. All VMs in a pool are the same size. For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

serializedName

serializedName: string = "PoolUsageMetrics"

type

type: object

className

className: string = "PoolUsageMetrics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

required

required: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

poolId

poolId: object

required

required: true = true

serializedName

serializedName: string = "poolId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

totalCoreHours

totalCoreHours: object

required

required: true = true

serializedName

serializedName: string = "totalCoreHours"

type

type: object

name

name: "Number" = "Number"

vmSize

vmSize: object

required

required: true = true

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

Const RecentJob

RecentJob: object

An interface representing RecentJob.

summary

Information about the most recent job to run under the job schedule.

Optional id

id: undefined | string

The ID of the job.

Optional url

url: undefined | string

The URL of the job.

serializedName

serializedName: string = "RecentJob"

type

type: object

className

className: string = "RecentJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const ResizeError

ResizeError: object

An interface representing ResizeError.

summary

An error that occurred when resizing a pool.

Optional code

code: undefined | string

An identifier for the pool resize error. Codes are invariant and are intended to be consumed programmatically.

Optional message

message: undefined | string

A message describing the pool resize error, intended to be suitable for display in a user interface.

Optional values

values: NameValuePair[]

A list of additional error details related to the pool resize error.

serializedName

serializedName: string = "ResizeError"

type

type: object

className

className: string = "ResizeError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

Const ResourceFile

ResourceFile: object

An interface representing ResourceFile.

summary

A single file or multiple files to be downloaded to a compute node.

Optional autoStorageContainerName

autoStorageContainerName: undefined | string

The storage container name in the auto storage account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

Optional blobPrefix

blobPrefix: undefined | string

The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

Optional fileMode

fileMode: undefined | string

The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

Optional filePath

filePath: undefined | string

The location on the compute node to which to download the file(s), relative to the task's working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

Optional httpUrl

httpUrl: undefined | string

The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

Optional storageContainerUrl

storageContainerUrl: undefined | string

The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, or set the ACL for the container to allow public access.

serializedName

serializedName: string = "ResourceFile"

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoStorageContainerName

autoStorageContainerName: object

serializedName

serializedName: string = "autoStorageContainerName"

type

type: object

name

name: "String" = "String"

blobPrefix

blobPrefix: object

serializedName

serializedName: string = "blobPrefix"

type

type: object

name

name: "String" = "String"

fileMode

fileMode: object

serializedName

serializedName: string = "fileMode"

type

type: object

name

name: "String" = "String"

filePath

filePath: object

serializedName

serializedName: string = "filePath"

type

type: object

name

name: "String" = "String"

httpUrl

httpUrl: object

serializedName

serializedName: string = "httpUrl"

type

type: object

name

name: "String" = "String"

storageContainerUrl

storageContainerUrl: object

serializedName

serializedName: string = "storageContainerUrl"

type

type: object

name

name: "String" = "String"

Const ResourceStatistics

ResourceStatistics: object

An interface representing ResourceStatistics.

summary

Statistics related to resource consumption by compute nodes in a pool.

avgCPUPercentage

avgCPUPercentage: number

The average CPU usage across all nodes in the pool (percentage per node).

avgDiskGiB

avgDiskGiB: number

The average used disk space in GiB across all nodes in the pool.

avgMemoryGiB

avgMemoryGiB: number

The average memory usage in GiB across all nodes in the pool.

diskReadGiB

diskReadGiB: number

The total amount of data in GiB of disk reads across all nodes in the pool.

diskReadIOps

diskReadIOps: number

The total number of disk read operations across all nodes in the pool.

diskWriteGiB

diskWriteGiB: number

The total amount of data in GiB of disk writes across all nodes in the pool.

diskWriteIOps

diskWriteIOps: number

The total number of disk write operations across all nodes in the pool.

lastUpdateTime

lastUpdateTime: Date

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

networkReadGiB

networkReadGiB: number

The total amount of data in GiB of network reads across all nodes in the pool.

networkWriteGiB

networkWriteGiB: number

The total amount of data in GiB of network writes across all nodes in the pool.

peakDiskGiB

peakDiskGiB: number

The peak used disk space in GiB across all nodes in the pool.

peakMemoryGiB

peakMemoryGiB: number

The peak memory usage in GiB across all nodes in the pool.

startTime

startTime: Date

The start time of the time range covered by the statistics.

serializedName

serializedName: string = "ResourceStatistics"

type

type: object

className

className: string = "ResourceStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

avgCPUPercentage

avgCPUPercentage: object

required

required: true = true

serializedName

serializedName: string = "avgCPUPercentage"

type

type: object

name

name: "Number" = "Number"

avgDiskGiB

avgDiskGiB: object

required

required: true = true

serializedName

serializedName: string = "avgDiskGiB"

type

type: object

name

name: "Number" = "Number"

avgMemoryGiB

avgMemoryGiB: object

required

required: true = true

serializedName

serializedName: string = "avgMemoryGiB"

type

type: object

name

name: "Number" = "Number"

diskReadGiB

diskReadGiB: object

required

required: true = true

serializedName

serializedName: string = "diskReadGiB"

type

type: object

name

name: "Number" = "Number"

diskReadIOps

diskReadIOps: object

required

required: true = true

serializedName

serializedName: string = "diskReadIOps"

type

type: object

name

name: "Number" = "Number"

diskWriteGiB

diskWriteGiB: object

required

required: true = true

serializedName

serializedName: string = "diskWriteGiB"

type

type: object

name

name: "Number" = "Number"

diskWriteIOps

diskWriteIOps: object

required

required: true = true

serializedName

serializedName: string = "diskWriteIOps"

type

type: object

name

name: "Number" = "Number"

lastUpdateTime

lastUpdateTime: object

required

required: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

networkReadGiB

networkReadGiB: object

required

required: true = true

serializedName

serializedName: string = "networkReadGiB"

type

type: object

name

name: "Number" = "Number"

networkWriteGiB

networkWriteGiB: object

required

required: true = true

serializedName

serializedName: string = "networkWriteGiB"

type

type: object

name

name: "Number" = "Number"

peakDiskGiB

peakDiskGiB: object

required

required: true = true

serializedName

serializedName: string = "peakDiskGiB"

type

type: object

name

name: "Number" = "Number"

peakMemoryGiB

peakMemoryGiB: object

required

required: true = true

serializedName

serializedName: string = "peakMemoryGiB"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const Schedule

Schedule: object

An interface representing Schedule.

summary

The schedule according to which jobs will be created

Optional doNotRunAfter

doNotRunAfter: Date

A time after which no job will be created under this job schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active job under this job schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring job schedule, the job schedule will remain active until you explicitly terminate it.

Optional doNotRunUntil

doNotRunUntil: Date

The earliest time at which any job may be created under this job schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create jobs immediately.

Optional recurrenceInterval

recurrenceInterval: undefined | string

The time interval between the start times of two successive jobs under the job schedule. A job schedule can have at most one active job under it at any given time. Because a job schedule can have at most one active job under it at any given time, if it is time to create a new job under a job schedule, but the previous job is still running, the Batch service will not create the new job until the previous job finishes. If the previous job does not finish within the startWindow period of the new recurrenceInterval, then no new job will be scheduled for that interval. For recurring jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when jobs are created, add tasks to the jobs and terminate the jobs ready for the next recurrence. The default is that the schedule does not recur: one job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional startWindow

startWindow: undefined | string

The time interval, starting from the time at which the schedule indicates a job should be created, within which a job must be created. If a job is not created within the startWindow interval, then the 'opportunity' is lost; no job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

serializedName

serializedName: string = "Schedule"

type

type: object

className

className: string = "Schedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

doNotRunAfter

doNotRunAfter: object

serializedName

serializedName: string = "doNotRunAfter"

type

type: object

name

name: "DateTime" = "DateTime"

doNotRunUntil

doNotRunUntil: object

serializedName

serializedName: string = "doNotRunUntil"

type

type: object

name

name: "DateTime" = "DateTime"

recurrenceInterval

recurrenceInterval: object

serializedName

serializedName: string = "recurrenceInterval"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

startWindow

startWindow: object

serializedName

serializedName: string = "startWindow"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const StartTask

StartTask: object

Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing. In some cases the start task may be re-run even though the node was not rebooted. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.

summary

A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.

commandLine

commandLine: string

The command line of the start task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

Optional containerSettings

containerSettings: TaskContainerSettings

The settings for the container under which the start task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

Optional environmentSettings

environmentSettings: EnvironmentSetting[]

A list of environment variable settings for the start task.

Optional maxTaskRetryCount

maxTaskRetryCount: undefined | number

The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.

Optional resourceFiles

resourceFiles: ResourceFile[]

A list of files that the Batch service will download to the compute node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the task's working directory.

Optional userIdentity

userIdentity: UserIdentity

The user identity under which the start task runs. If omitted, the task runs as a non-administrative user unique to the task.

Optional waitForSuccess

waitForSuccess: undefined | false | true

Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node. If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and failure info details. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is false.

serializedName

serializedName: string = "StartTask"

type

type: object

className

className: string = "StartTask"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

commandLine

commandLine: object

required

required: true = true

serializedName

serializedName: string = "commandLine"

type

type: object

name

name: "String" = "String"

containerSettings

containerSettings: object

serializedName

serializedName: string = "containerSettings"

type

type: object

className

className: string = "TaskContainerSettings"

name

name: "Composite" = "Composite"

environmentSettings

environmentSettings: object

serializedName

serializedName: string = "environmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

maxTaskRetryCount

maxTaskRetryCount: object

serializedName

serializedName: string = "maxTaskRetryCount"

type

type: object

name

name: "Number" = "Number"

resourceFiles

resourceFiles: object

serializedName

serializedName: string = "resourceFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

userIdentity

userIdentity: object

serializedName

serializedName: string = "userIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

waitForSuccess

waitForSuccess: object

serializedName

serializedName: string = "waitForSuccess"

type

type: object

name

name: "Boolean" = "Boolean"

Const StartTaskInformation

StartTaskInformation: object

An interface representing StartTaskInformation.

summary

Information about a start task running on a compute node.

Optional containerInfo

Information about the container under which the task is executing. This property is set only if the task runs in a container context.

Optional endTime

endTime: Date

The time at which the start task stopped running. This is the end time of the most recent run of the start task, if that run has completed (even if that run failed and a retry is pending). This element is not present if the start task is currently running.

Optional exitCode

exitCode: undefined | number

The exit code of the program specified on the start task command line. This property is set only if the start task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the start task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Optional failureInfo

Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.

Optional lastRetryTime

lastRetryTime: Date

The most recent time at which a retry of the task started running. This element is present only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.

Optional result

The result of the task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'

retryCount

retryCount: number

The number of times the task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.

startTime

startTime: Date

The time at which the start task started running. This value is reset every time the task is restarted or retried (that is, this is the most recent time at which the start task started running).

state

The state of the start task on the compute node. Possible values include: 'running', 'completed'

serializedName

serializedName: string = "StartTaskInformation"

type

type: object

className

className: string = "StartTaskInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerInfo

containerInfo: object

serializedName

serializedName: string = "containerInfo"

type

type: object

className

className: string = "TaskContainerExecutionInformation"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exitCode

exitCode: object

serializedName

serializedName: string = "exitCode"

type

type: object

name

name: "Number" = "Number"

failureInfo

failureInfo: object

serializedName

serializedName: string = "failureInfo"

type

type: object

className

className: string = "TaskFailureInformation"

name

name: "Composite" = "Composite"

lastRetryTime

lastRetryTime: object

serializedName

serializedName: string = "lastRetryTime"

type

type: object

name

name: "DateTime" = "DateTime"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

allowedValues

allowedValues: string[] = ["success","failure"]

name

name: "Enum" = "Enum"

retryCount

retryCount: object

required

required: true = true

serializedName

serializedName: string = "retryCount"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

required

required: true = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["running","completed"]

name

name: "Enum" = "Enum"

Const SubtaskInformation

SubtaskInformation: object

An interface representing SubtaskInformation.

summary

Information about an Azure Batch subtask.

Optional containerInfo

Information about the container under which the task is executing. This property is set only if the task runs in a container context.

Optional endTime

endTime: Date

The time at which the subtask completed. This property is set only if the subtask is in the Completed state.

Optional exitCode

exitCode: undefined | number

The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Optional failureInfo

Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.

Optional id

id: undefined | number

The ID of the subtask.

Optional nodeInfo

Information about the compute node on which the subtask ran.

Optional previousState

previousState: SubtaskState

The previous state of the subtask. This property is not set if the subtask is in its initial running state. Possible values include: 'preparing', 'running', 'completed'

Optional previousStateTransitionTime

previousStateTransitionTime: Date

The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state.

Optional result

The result of the task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'

Optional startTime

startTime: Date

The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running.

Optional state

The current state of the subtask. Possible values include: 'preparing', 'running', 'completed'

Optional stateTransitionTime

stateTransitionTime: Date

The time at which the subtask entered its current state.

serializedName

serializedName: string = "SubtaskInformation"

type

type: object

className

className: string = "SubtaskInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerInfo

containerInfo: object

serializedName

serializedName: string = "containerInfo"

type

type: object

className

className: string = "TaskContainerExecutionInformation"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exitCode

exitCode: object

serializedName

serializedName: string = "exitCode"

type

type: object

name

name: "Number" = "Number"

failureInfo

failureInfo: object

serializedName

serializedName: string = "failureInfo"

type

type: object

className

className: string = "TaskFailureInformation"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "Number" = "Number"

nodeInfo

nodeInfo: object

serializedName

serializedName: string = "nodeInfo"

type

type: object

className

className: string = "ComputeNodeInformation"

name

name: "Composite" = "Composite"

previousState

previousState: object

serializedName

serializedName: string = "previousState"

type

type: object

allowedValues

allowedValues: string[] = ["preparing","running","completed"]

name

name: "Enum" = "Enum"

previousStateTransitionTime

previousStateTransitionTime: object

serializedName

serializedName: string = "previousStateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

allowedValues

allowedValues: string[] = ["success","failure"]

name

name: "Enum" = "Enum"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["preparing","running","completed"]

name

name: "Enum" = "Enum"

stateTransitionTime

stateTransitionTime: object

serializedName

serializedName: string = "stateTransitionTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const TaskAddCollectionHeaders

TaskAddCollectionHeaders: object

Defines headers for AddCollection operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-addcollection-headers"

type

type: object

className

className: string = "TaskAddCollectionHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const TaskAddCollectionOptions

TaskAddCollectionOptions: object

Additional parameters for addCollection operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskAddCollectionOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskAddCollectionParameter

TaskAddCollectionParameter: object

An interface representing TaskAddCollectionParameter.

summary

A collection of Azure Batch tasks to add.

value

The collection of tasks to add. The maximum count of tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer tasks.

serializedName

serializedName: string = "TaskAddCollectionParameter"

type

type: object

className

className: string = "TaskAddCollectionParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

constraints

constraints: object

MaxItems

MaxItems: number = 100

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TaskAddParameter"

name

name: "Composite" = "Composite"

Const TaskAddCollectionResult

TaskAddCollectionResult: object

An interface representing TaskAddCollectionResult.

summary

The result of adding a collection of tasks to a job.

Optional value

value: TaskAddResult[]

The results of the add task collection operation.

serializedName

serializedName: string = "TaskAddCollectionResult"

type

type: object

className

className: string = "TaskAddCollectionResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TaskAddResult"

name

name: "Composite" = "Composite"

Const TaskAddHeaders

TaskAddHeaders: object

Defines headers for Add operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-add-headers"

type

type: object

className

className: string = "TaskAddHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const TaskAddOptions

TaskAddOptions: object

Additional parameters for add operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskAddOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskAddParameter

TaskAddParameter: object

Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing.

summary

An Azure Batch task to add.

Optional affinityInfo

affinityInfo: AffinityInformation

A locality hint that can be used by the Batch service to select a compute node on which to start the new task.

Optional applicationPackageReferences

applicationPackageReferences: ApplicationPackageReference[]

A list of application packages that the Batch service will deploy to the compute node before running the command line. Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails.

Optional authenticationTokenSettings

authenticationTokenSettings: AuthenticationTokenSettings

The settings for an authentication token that the task can use to perform Batch service operations. If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.

commandLine

commandLine: string

The command line of the task. For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

Optional constraints

constraints: TaskConstraints

The execution constraints that apply to this task. If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the job, the maxWallClockTime is infinite, and the retentionTime is 7 days.

Optional containerSettings

containerSettings: TaskContainerSettings

The settings for the container under which the task runs. If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container.

Optional dependsOn

dependsOn: TaskDependencies

The tasks that this task depends on. This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled. If the job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob.

Optional displayName

displayName: undefined | string

A display name for the task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Optional environmentSettings

environmentSettings: EnvironmentSetting[]

A list of environment variable settings for the task.

Optional exitConditions

exitConditions: ExitConditions

How the Batch service should respond when the task completes.

id

id: string

A string that uniquely identifies the task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a job that differ only by case).

Optional multiInstanceSettings

multiInstanceSettings: MultiInstanceSettings

An object that indicates that the task is a multi-instance task, and contains information about how to run the multi-instance task.

Optional outputFiles

outputFiles: OutputFile[]

A list of files that the Batch service will upload from the compute node after running the command line. For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.

Optional resourceFiles

resourceFiles: ResourceFile[]

A list of files that the Batch service will download to the compute node before running the command line. For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.

Optional userIdentity

userIdentity: UserIdentity

The user identity under which the task runs. If omitted, the task runs as a non-administrative user unique to the task.

serializedName

serializedName: string = "TaskAddParameter"

type

type: object

className

className: string = "TaskAddParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

affinityInfo

affinityInfo: object

serializedName

serializedName: string = "affinityInfo"

type

type: object

className

className: string = "AffinityInformation"

name

name: "Composite" = "Composite"

applicationPackageReferences

applicationPackageReferences: object

serializedName

serializedName: string = "applicationPackageReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationPackageReference"

name

name: "Composite" = "Composite"

authenticationTokenSettings

authenticationTokenSettings: object

serializedName

serializedName: string = "authenticationTokenSettings"

type

type: object

className

className: string = "AuthenticationTokenSettings"

name

name: "Composite" = "Composite"

commandLine

commandLine: object

required

required: true = true

serializedName

serializedName: string = "commandLine"

type

type: object

name

name: "String" = "String"

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "TaskConstraints"

name

name: "Composite" = "Composite"

containerSettings

containerSettings: object

serializedName

serializedName: string = "containerSettings"

type

type: object

className

className: string = "TaskContainerSettings"

name

name: "Composite" = "Composite"

dependsOn

dependsOn: object

serializedName

serializedName: string = "dependsOn"

type

type: object

className

className: string = "TaskDependencies"

name

name: "Composite" = "Composite"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

environmentSettings

environmentSettings: object

serializedName

serializedName: string = "environmentSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EnvironmentSetting"

name

name: "Composite" = "Composite"

exitConditions

exitConditions: object

serializedName

serializedName: string = "exitConditions"

type

type: object

className

className: string = "ExitConditions"

name

name: "Composite" = "Composite"

id

id: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

multiInstanceSettings

multiInstanceSettings: object

serializedName

serializedName: string = "multiInstanceSettings"

type

type: object

className

className: string = "MultiInstanceSettings"

name

name: "Composite" = "Composite"

outputFiles

outputFiles: object

serializedName

serializedName: string = "outputFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OutputFile"

name

name: "Composite" = "Composite"

resourceFiles

resourceFiles: object

serializedName

serializedName: string = "resourceFiles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceFile"

name

name: "Composite" = "Composite"

userIdentity

userIdentity: object

serializedName

serializedName: string = "userIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

Const TaskAddResult

TaskAddResult: object

An interface representing TaskAddResult.

summary

Result for a single task added as part of an add task collection operation.

Optional eTag

eTag: undefined | string

The ETag of the task, if the task was successfully added. You can use this to detect whether the task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the job in the meantime.

Optional error

error: BatchError

The error encountered while attempting to add the task.

Optional lastModified

lastModified: Date

The last modified time of the task.

Optional location

location: undefined | string

The URL of the task, if the task was successfully added.

status

The status of the add task request. Possible values include: 'success', 'clientError', 'serverError'

taskId

taskId: string

The ID of the task for which this is the result.

serializedName

serializedName: string = "TaskAddResult"

type

type: object

className

className: string = "TaskAddResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "eTag"

type

type: object

name

name: "String" = "String"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "BatchError"

name

name: "Composite" = "Composite"

lastModified

lastModified: object

serializedName

serializedName: string = "lastModified"

type

type: object

name

name: "DateTime" = "DateTime"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

status

status: object

required

required: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["success","clienterror","servererror"]

name

name: "Enum" = "Enum"

taskId

taskId: object

required

required: true = true

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const TaskConstraints

TaskConstraints: object

An interface representing TaskConstraints.

summary

Execution constraints to apply to a task.

Optional maxTaskRetryCount

maxTaskRetryCount: undefined | number

The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries for the task executable due to a nonzero exit code. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task after the first attempt. If the maximum retry count is -1, the Batch service retries the task without limit.

Optional maxWallClockTime

maxWallClockTime: undefined | string

The maximum elapsed time that the task may run, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. If this is not specified, there is no time limit on how long the task may run.

Optional retentionTime

retentionTime: undefined | string

The minimum time to retain the task directory on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the task directory and all its contents. The default is 7 days, i.e. the task directory will be retained for 7 days unless the compute node is removed or the job is deleted.

serializedName

serializedName: string = "TaskConstraints"

type

type: object

className

className: string = "TaskConstraints"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxTaskRetryCount

maxTaskRetryCount: object

serializedName

serializedName: string = "maxTaskRetryCount"

type

type: object

name

name: "Number" = "Number"

maxWallClockTime

maxWallClockTime: object

serializedName

serializedName: string = "maxWallClockTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

retentionTime

retentionTime: object

serializedName

serializedName: string = "retentionTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

Const TaskContainerExecutionInformation

TaskContainerExecutionInformation: object

An interface representing TaskContainerExecutionInformation.

summary

Contains information about the container which a task is executing.

Optional containerId

containerId: undefined | string

The ID of the container.

Optional error

error: undefined | string

Detailed error information about the container. This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by "docker inspect".

Optional state

state: undefined | string

The state of the container. This is the state of the container according to the Docker service. It is equivalent to the status field returned by "docker inspect".

serializedName

serializedName: string = "TaskContainerExecutionInformation"

type

type: object

className

className: string = "TaskContainerExecutionInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerId

containerId: object

serializedName

serializedName: string = "containerId"

type

type: object

name

name: "String" = "String"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

name

name: "String" = "String"

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const TaskContainerSettings

TaskContainerSettings: object

An interface representing TaskContainerSettings.

summary

The container settings for a task.

Optional containerRunOptions

containerRunOptions: undefined | string

Additional options to the container create command. These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service.

imageName

imageName: string

The image to use to create the container in which the task will run. This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default.

Optional registry

The private registry which contains the container image. This setting can be omitted if was already provided at pool creation.

serializedName

serializedName: string = "TaskContainerSettings"

type

type: object

className

className: string = "TaskContainerSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerRunOptions

containerRunOptions: object

serializedName

serializedName: string = "containerRunOptions"

type

type: object

name

name: "String" = "String"

imageName

imageName: object

required

required: true = true

serializedName

serializedName: string = "imageName"

type

type: object

name

name: "String" = "String"

registry

registry: object

serializedName

serializedName: string = "registry"

type

type: object

className

className: string = "ContainerRegistry"

name

name: "Composite" = "Composite"

Const TaskCounts

TaskCounts: object

An interface representing TaskCounts.

summary

The task counts for a job.

active

active: number

The number of tasks in the active state.

completed

completed: number

The number of tasks in the completed state.

failed

failed: number

The number of tasks which failed. A task fails if its result (found in the executionInfo property) is 'failure'.

running

running: number

The number of tasks in the running or preparing state.

succeeded

succeeded: number

The number of tasks which succeeded. A task succeeds if its result (found in the executionInfo property) is 'success'.

serializedName

serializedName: string = "TaskCounts"

type

type: object

className

className: string = "TaskCounts"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

active

active: object

required

required: true = true

serializedName

serializedName: string = "active"

type

type: object

name

name: "Number" = "Number"

completed

completed: object

required

required: true = true

serializedName

serializedName: string = "completed"

type

type: object

name

name: "Number" = "Number"

failed

failed: object

required

required: true = true

serializedName

serializedName: string = "failed"

type

type: object

name

name: "Number" = "Number"

running

running: object

required

required: true = true

serializedName

serializedName: string = "running"

type

type: object

name

name: "Number" = "Number"

succeeded

succeeded: object

required

required: true = true

serializedName

serializedName: string = "succeeded"

type

type: object

name

name: "Number" = "Number"

Const TaskDeleteHeaders

TaskDeleteHeaders: object

Defines headers for Delete operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-delete-headers"

type

type: object

className

className: string = "TaskDeleteHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "String" = "String"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "String" = "String"

Const TaskDeleteMethodOptions

TaskDeleteMethodOptions: object

Additional parameters for deleteMethod operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskDeleteMethodOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskDependencies

TaskDependencies: object

An interface representing TaskDependencies.

summary

Specifies any dependencies of a task. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled.

Optional taskIdRanges

taskIdRanges: TaskIdRange[]

The list of task ID ranges that this task depends on. All tasks in all ranges must complete successfully before the dependent task can be scheduled.

Optional taskIds

taskIds: string[]

The list of task IDs that this task depends on. All tasks in this list must complete successfully before the dependent task can be scheduled. The taskIds collection is limited to 64000 characters total (i.e. the combined length of all task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using task ID ranges instead.

serializedName

serializedName: string = "TaskDependencies"

type

type: object

className

className: string = "TaskDependencies"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

taskIdRanges

taskIdRanges: object

serializedName

serializedName: string = "taskIdRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TaskIdRange"

name

name: "Composite" = "Composite"

taskIds

taskIds: object

serializedName

serializedName: string = "taskIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const TaskExecutionInformation

TaskExecutionInformation: object

An interface representing TaskExecutionInformation.

summary

Information about the execution of a task.

Optional containerInfo

Information about the container under which the task is executing. This property is set only if the task runs in a container context.

Optional endTime

endTime: Date

The time at which the task completed. This property is set only if the task is in the Completed state.

Optional exitCode

exitCode: undefined | number

The exit code of the program specified on the task command line. This property is set only if the task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.

Optional failureInfo

Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.

Optional lastRequeueTime

lastRequeueTime: Date

The most recent time at which the task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero.

Optional lastRetryTime

lastRetryTime: Date

The most recent time at which a retry of the task started running. This element is present only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.

requeueCount

requeueCount: number

The number of times the task has been requeued by the Batch service as the result of a user request. When the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.

Optional result

The result of the task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property. Possible values include: 'success', 'failure'

retryCount

retryCount: number

The number of times the task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.

Optional startTime

startTime: Date

The time at which the task started running. 'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state.

serializedName

serializedName: string = "TaskExecutionInformation"

type

type: object

className

className: string = "TaskExecutionInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerInfo

containerInfo: object

serializedName

serializedName: string = "containerInfo"

type

type: object

className

className: string = "TaskContainerExecutionInformation"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

exitCode

exitCode: object

serializedName

serializedName: string = "exitCode"

type

type: object

name

name: "Number" = "Number"

failureInfo

failureInfo: object

serializedName

serializedName: string = "failureInfo"

type

type: object

className

className: string = "TaskFailureInformation"

name

name: "Composite" = "Composite"

lastRequeueTime

lastRequeueTime: object

serializedName

serializedName: string = "lastRequeueTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastRetryTime

lastRetryTime: object

serializedName

serializedName: string = "lastRetryTime"

type

type: object

name

name: "DateTime" = "DateTime"

requeueCount

requeueCount: object

required

required: true = true

serializedName

serializedName: string = "requeueCount"

type

type: object

name

name: "Number" = "Number"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

allowedValues

allowedValues: string[] = ["success","failure"]

name

name: "Enum" = "Enum"

retryCount

retryCount: object

required

required: true = true

serializedName

serializedName: string = "retryCount"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const TaskFailureInformation

TaskFailureInformation: object

An interface representing TaskFailureInformation.

summary

Information about a task failure.

category

category: ErrorCategory

The category of the task error. Possible values include: 'userError', 'serverError'

Optional code

code: undefined | string

An identifier for the task error. Codes are invariant and are intended to be consumed programmatically.

Optional details

details: NameValuePair[]

A list of additional details related to the error.

Optional message

message: undefined | string

A message describing the task error, intended to be suitable for display in a user interface.

serializedName

serializedName: string = "TaskFailureInformation"

type

type: object

className

className: string = "TaskFailureInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

category

category: object

required

required: true = true

serializedName

serializedName: string = "category"

type

type: object

allowedValues

allowedValues: string[] = ["usererror","servererror"]

name

name: "Enum" = "Enum"

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const TaskGetHeaders

TaskGetHeaders: object

Defines headers for Get operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTagHeader

eTagHeader: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModifiedHeader

lastModifiedHeader: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-get-headers"

type

type: object

className

className: string = "TaskGetHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTagHeader

eTagHeader: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModifiedHeader

lastModifiedHeader: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const TaskGetOptions

TaskGetOptions: object

Additional parameters for get operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskGetOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskIdRange

TaskIdRange: object

The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents tasks '9', '10', '11' and '12'.

summary

A range of task IDs that a task can depend on. All tasks with IDs in the range must complete successfully before the dependent task can be scheduled.

end

end: number

The last task ID in the range.

start

start: number

The first task ID in the range.

serializedName

serializedName: string = "TaskIdRange"

type

type: object

className

className: string = "TaskIdRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

end

end: object

required

required: true = true

serializedName

serializedName: string = "end"

type

type: object

name

name: "Number" = "Number"

start

start: object

required

required: true = true

serializedName

serializedName: string = "start"

type

type: object

name

name: "Number" = "Number"

Const TaskInformation

TaskInformation: object

An interface representing TaskInformation.

summary

Information about a task running on a compute node.

Optional executionInfo

Information about the execution of the task.

Optional jobId

jobId: undefined | string

The ID of the job to which the task belongs.

Optional subtaskId

subtaskId: undefined | number

The ID of the subtask if the task is a multi-instance task.

Optional taskId

taskId: undefined | string

The ID of the task.

taskState

taskState: TaskState

The current state of the task. Possible values include: 'active', 'preparing', 'running', 'completed'

Optional taskUrl

taskUrl: undefined | string

The URL of the task.

serializedName

serializedName: string = "TaskInformation"

type

type: object

className

className: string = "TaskInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

executionInfo

executionInfo: object

serializedName

serializedName: string = "executionInfo"

type

type: object

className

className: string = "TaskExecutionInformation"

name

name: "Composite" = "Composite"

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

subtaskId

subtaskId: object

serializedName

serializedName: string = "subtaskId"

type

type: object

name

name: "Number" = "Number"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

taskState

taskState: object

required

required: true = true

serializedName

serializedName: string = "taskState"

type

type: object

allowedValues

allowedValues: string[] = ["active","preparing","running","completed"]

name

name: "Enum" = "Enum"

taskUrl

taskUrl: object

serializedName

serializedName: string = "taskUrl"

type

type: object

name

name: "String" = "String"

Const TaskListHeaders

TaskListHeaders: object

Defines headers for List operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-list-headers"

type

type: object

className

className: string = "TaskListHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const TaskListNextOptions

TaskListNextOptions: object

Additional parameters for listNext operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

type

type: object

className

className: string = "TaskListNextOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

Const TaskListOptions

TaskListOptions: object

Additional parameters for list operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional expand

expand: undefined | string

An OData $expand clause.

Optional filter

filter: undefined | string

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.

Optional maxResults

maxResults: undefined | number

The maximum number of items to return in the response. A maximum of 1000 tasks can be returned. Default value: 1000.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskListOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

expand

expand: object

type

type: object

name

name: "String" = "String"

filter

filter: object

type

type: object

name

name: "String" = "String"

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

name: "Number" = "Number"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskListSubtasksHeaders

TaskListSubtasksHeaders: object

Defines headers for ListSubtasks operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-listsubtasks-headers"

type

type: object

className

className: string = "TaskListSubtasksHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const TaskListSubtasksOptions

TaskListSubtasksOptions: object

Additional parameters for listSubtasks operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional select

select: undefined | string

An OData $select clause.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskListSubtasksOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

select

select: object

type

type: object

name

name: "String" = "String"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskReactivateHeaders

TaskReactivateHeaders: object

Defines headers for Reactivate operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-reactivate-headers"

type

type: object

className

className: string = "TaskReactivateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const TaskReactivateOptions

TaskReactivateOptions: object

Additional parameters for reactivate operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskReactivateOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskSchedulingPolicy

TaskSchedulingPolicy: object

An interface representing TaskSchedulingPolicy.

summary

Specifies how tasks should be distributed across compute nodes.

nodeFillType

nodeFillType: ComputeNodeFillType

How tasks are distributed across compute nodes in a pool. Possible values include: 'spread', 'pack'

serializedName

serializedName: string = "TaskSchedulingPolicy"

type

type: object

className

className: string = "TaskSchedulingPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nodeFillType

nodeFillType: object

required

required: true = true

serializedName

serializedName: string = "nodeFillType"

type

type: object

allowedValues

allowedValues: string[] = ["spread","pack"]

name

name: "Enum" = "Enum"

Const TaskStatistics

TaskStatistics: object

An interface representing TaskStatistics.

summary

Resource usage statistics for a task.

kernelCPUTime

kernelCPUTime: string

The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by the task.

lastUpdateTime

lastUpdateTime: Date

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

readIOGiB

readIOGiB: number

The total gibibytes read from disk by the task.

readIOps

readIOps: number

The total number of disk read operations made by the task.

startTime

startTime: Date

The start time of the time range covered by the statistics.

url

url: string

The URL of the statistics.

userCPUTime

userCPUTime: string

The total user mode CPU time (summed across all cores and all compute nodes) consumed by the task.

waitTime

waitTime: string

The total wait time of the task. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.).

wallClockTime

wallClockTime: string

The total wall clock time of the task. The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If the task was retried, this includes the wall clock time of all the task retries.

writeIOGiB

writeIOGiB: number

The total gibibytes written to disk by the task.

writeIOps

writeIOps: number

The total number of disk write operations made by the task.

serializedName

serializedName: string = "TaskStatistics"

type

type: object

className

className: string = "TaskStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

kernelCPUTime

kernelCPUTime: object

required

required: true = true

serializedName

serializedName: string = "kernelCPUTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

lastUpdateTime

lastUpdateTime: object

required

required: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

readIOGiB

readIOGiB: object

required

required: true = true

serializedName

serializedName: string = "readIOGiB"

type

type: object

name

name: "Number" = "Number"

readIOps

readIOps: object

required

required: true = true

serializedName

serializedName: string = "readIOps"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

url

url: object

required

required: true = true

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

userCPUTime

userCPUTime: object

required

required: true = true

serializedName

serializedName: string = "userCPUTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

waitTime

waitTime: object

required

required: true = true

serializedName

serializedName: string = "waitTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

wallClockTime

wallClockTime: object

required

required: true = true

serializedName

serializedName: string = "wallClockTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

writeIOGiB

writeIOGiB: object

required

required: true = true

serializedName

serializedName: string = "writeIOGiB"

type

type: object

name

name: "Number" = "Number"

writeIOps

writeIOps: object

required

required: true = true

serializedName

serializedName: string = "writeIOps"

type

type: object

name

name: "Number" = "Number"

Const TaskTerminateHeaders

TaskTerminateHeaders: object

Defines headers for Terminate operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-terminate-headers"

type

type: object

className

className: string = "TaskTerminateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const TaskTerminateOptions

TaskTerminateOptions: object

Additional parameters for terminate operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskTerminateOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskUpdateHeaders

TaskUpdateHeaders: object

Defines headers for Update operation.

clientRequestId

clientRequestId: string

The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.

dataServiceId

dataServiceId: string

The OData ID of the resource to which the request applied.

eTag

eTag: string

The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.

lastModified

lastModified: Date

The time at which the resource was last modified.

requestId

requestId: string

A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.

serializedName

serializedName: string = "task-update-headers"

type

type: object

className

className: string = "TaskUpdateHeaders"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

dataServiceId

dataServiceId: object

serializedName

serializedName: string = "dataserviceid"

type

type: object

name

name: "String" = "String"

eTag

eTag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

lastModified

lastModified: object

serializedName

serializedName: string = "last-modified"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

requestId

requestId: object

serializedName

serializedName: string = "request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const TaskUpdateOptions

TaskUpdateOptions: object

Additional parameters for update operation.

Optional clientRequestId

clientRequestId: undefined | string

The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

Optional ifMatch

ifMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.

Optional ifModifiedSince

ifModifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.

Optional ifNoneMatch

ifNoneMatch: undefined | string

An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.

Optional ifUnmodifiedSince

ifUnmodifiedSince: Date

A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.

Optional ocpDate

ocpDate: Date

The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.

Optional returnClientRequestId

returnClientRequestId: undefined | false | true

Whether the server should return the client-request-id in the response. Default value: false.

Optional timeout

timeout: undefined | number

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30.

type

type: object

className

className: string = "TaskUpdateOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

type

type: object

name

name: "Uuid" = "Uuid"

ifMatch

ifMatch: object

type

type: object

name

name: "String" = "String"

ifModifiedSince

ifModifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: "String" = "String"

ifUnmodifiedSince

ifUnmodifiedSince: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

ocpDate

ocpDate: object

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

returnClientRequestId

returnClientRequestId: object

defaultValue

defaultValue: boolean = false

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

defaultValue

defaultValue: number = 30

type

type: object

name

name: "Number" = "Number"

Const TaskUpdateParameter

TaskUpdateParameter: object

An interface representing TaskUpdateParameter.

summary

The set of changes to be made to a task.

Optional constraints

constraints: TaskConstraints

Constraints that apply to this task. If omitted, the task is given the default constraints. For multi-instance tasks, updating the retention time applies only to the primary task and not subtasks.

serializedName

serializedName: string = "TaskUpdateParameter"

type

type: object

className

className: string = "TaskUpdateParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

constraints

constraints: object

serializedName

serializedName: string = "constraints"

type

type: object

className

className: string = "TaskConstraints"

name

name: "Composite" = "Composite"

Const UploadBatchServiceLogsConfiguration

UploadBatchServiceLogsConfiguration: object

An interface representing UploadBatchServiceLogsConfiguration.

summary

The Azure Batch service log files upload configuration for a compute node.

containerUrl

containerUrl: string

The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). The URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified.

Optional endTime

endTime: Date

The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime.

startTime

startTime: Date

The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested.

serializedName

serializedName: string = "UploadBatchServiceLogsConfiguration"

type

type: object

className

className: string = "UploadBatchServiceLogsConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerUrl

containerUrl: object

required

required: true = true

serializedName

serializedName: string = "containerUrl"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const UploadBatchServiceLogsResult

UploadBatchServiceLogsResult: object

An interface representing UploadBatchServiceLogsResult.

summary

The result of uploading Batch service log files from a specific compute node.

numberOfFilesUploaded

numberOfFilesUploaded: number

The number of log files which will be uploaded.

virtualDirectoryName

virtualDirectoryName: string

The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded. The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier.

serializedName

serializedName: string = "UploadBatchServiceLogsResult"

type

type: object

className

className: string = "UploadBatchServiceLogsResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

numberOfFilesUploaded

numberOfFilesUploaded: object

required

required: true = true

serializedName

serializedName: string = "numberOfFilesUploaded"

type

type: object

name

name: "Number" = "Number"

virtualDirectoryName

virtualDirectoryName: object

required

required: true = true

serializedName

serializedName: string = "virtualDirectoryName"

type

type: object

name

name: "String" = "String"

Const UsageStatistics

UsageStatistics: object

An interface representing UsageStatistics.

summary

Statistics related to pool usage information.

dedicatedCoreTime

dedicatedCoreTime: string

The aggregated wall-clock time of the dedicated compute node cores being part of the pool.

lastUpdateTime

lastUpdateTime: Date

The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.

startTime

startTime: Date

The start time of the time range covered by the statistics.

serializedName

serializedName: string = "UsageStatistics"

type

type: object

className

className: string = "UsageStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dedicatedCoreTime

dedicatedCoreTime: object

required

required: true = true

serializedName

serializedName: string = "dedicatedCoreTime"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

lastUpdateTime

lastUpdateTime: object

required

required: true = true

serializedName

serializedName: string = "lastUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const UserAccount

UserAccount: object

An interface representing UserAccount.

summary

Properties used to create a user used to execute tasks on an Azure Batch node.

Optional elevationLevel

elevationLevel: ElevationLevel

The elevation level of the user account. The default value is nonAdmin. Possible values include: 'nonAdmin', 'admin'

Optional linuxUserConfiguration

linuxUserConfiguration: LinuxUserConfiguration

The Linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.

name

name: string

The name of the user account.

password

password: string

The password for the user account.

Optional windowsUserConfiguration

windowsUserConfiguration: WindowsUserConfiguration

The Windows-specific user configuration for the user account. This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.

serializedName

serializedName: string = "UserAccount"

type

type: object

className

className: string = "UserAccount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

elevationLevel

elevationLevel: object

serializedName

serializedName: string = "elevationLevel"

type

type: object

allowedValues

allowedValues: string[] = ["nonadmin","admin"]

name

name: "Enum" = "Enum"

linuxUserConfiguration

linuxUserConfiguration: object

serializedName

serializedName: string = "linuxUserConfiguration"

type

type: object

className

className: string = "LinuxUserConfiguration"

name

name: "Composite" = "Composite"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

password

password: object

required

required: true = true

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

windowsUserConfiguration

windowsUserConfiguration: object

serializedName

serializedName: string = "windowsUserConfiguration"

type

type: object

className

className: string = "WindowsUserConfiguration"

name

name: "Composite" = "Composite"

Const UserIdentity

UserIdentity: object

Specify either the userName or autoUser property, but not both.

summary

The definition of the user identity under which the task is run.

Optional autoUser

The auto user under which the task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both.

Optional userName

userName: undefined | string

The name of the user identity under which the task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both.

serializedName

serializedName: string = "UserIdentity"

type

type: object

className

className: string = "UserIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoUser

autoUser: object

serializedName

serializedName: string = "autoUser"

type

type: object

className

className: string = "AutoUserSpecification"

name

name: "Composite" = "Composite"

userName

userName: object

serializedName

serializedName: string = "username"

type

type: object

name

name: "String" = "String"

Const VirtualMachineConfiguration

VirtualMachineConfiguration: object

An interface representing VirtualMachineConfiguration.

summary

The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

Optional containerConfiguration

containerConfiguration: ContainerConfiguration

The container configuration for the pool. If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it.

Optional dataDisks

dataDisks: DataDisk[]

The configuration for data disks attached to the compute nodes in the pool. This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

imageReference

imageReference: ImageReference

A reference to the Azure Virtual Machines Marketplace image or the custom Virtual Machine image to use.

Optional licenseType

licenseType: undefined | string

The type of on-premises license to be used when deploying the operating system. This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:

Windows_Server - The on-premises license is for Windows Server. Windows_Client - The on-premises license is for Windows Client.

nodeAgentSKUId

nodeAgentSKUId: string

The SKU of the Batch node agent to be provisioned on compute nodes in the pool. The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation.

Optional windowsConfiguration

windowsConfiguration: WindowsConfiguration

Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS image.

serializedName

serializedName: string = "VirtualMachineConfiguration"

type

type: object

className

className: string = "VirtualMachineConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerConfiguration

containerConfiguration: object

serializedName

serializedName: string = "containerConfiguration"

type

type: object

className

className: string = "ContainerConfiguration"

name

name: "Composite" = "Composite"

dataDisks

dataDisks: object

serializedName

serializedName: string = "dataDisks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DataDisk"

name

name: "Composite" = "Composite"

imageReference

imageReference: object

required

required: true = true

serializedName

serializedName: string = "imageReference"

type

type: object

className

className: string = "ImageReference"

name

name: "Composite" = "Composite"

licenseType

licenseType: object

serializedName

serializedName: string = "licenseType"

type

type: object

name

name: "String" = "String"

nodeAgentSKUId

nodeAgentSKUId: object

required

required: true = true

serializedName

serializedName: string = "nodeAgentSKUId"

type

type: object

name

name: "String" = "String"

windowsConfiguration

windowsConfiguration: object

serializedName

serializedName: string = "windowsConfiguration"

type

type: object

className

className: string = "WindowsConfiguration"

name

name: "Composite" = "Composite"

Const WindowsConfiguration

WindowsConfiguration: object

An interface representing WindowsConfiguration.

summary

Windows operating system settings to apply to the virtual machine.

Optional enableAutomaticUpdates

enableAutomaticUpdates: undefined | false | true

Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true.

serializedName

serializedName: string = "WindowsConfiguration"

type

type: object

className

className: string = "WindowsConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enableAutomaticUpdates

enableAutomaticUpdates: object

serializedName

serializedName: string = "enableAutomaticUpdates"

type

type: object

name

name: "Boolean" = "Boolean"

Const WindowsUserConfiguration

WindowsUserConfiguration: object

An interface representing WindowsUserConfiguration.

summary

Properties used to create a user account on a Windows node.

Optional loginMode

loginMode: LoginMode

The login mode for the user. The default value for VirtualMachineConfiguration pools is batch and for CloudServiceConfiguration pools is interactive. Possible values include: 'batch', 'interactive'

serializedName

serializedName: string = "WindowsUserConfiguration"

type

type: object

className

className: string = "WindowsUserConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

loginMode

loginMode: object

serializedName

serializedName: string = "loginMode"

type

type: object

allowedValues

allowedValues: string[] = ["batch","interactive"]

name

name: "Enum" = "Enum"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const applicationId

applicationId: object

parameterPath

parameterPath: string = "applicationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "applicationId"

type

type: object

name

name: "String" = "String"

Const batchUrl

batchUrl: object

parameterPath

parameterPath: string = "batchUrl"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: true = true

serializedName

serializedName: string = "batchUrl"

type

type: object

name

name: "String" = "String"

Const clientRequestId0

clientRequestId0: object

parameterPath

parameterPath: string[] = ["options","applicationListOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId1

clientRequestId1: object

parameterPath

parameterPath: string[] = ["options","applicationGetOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId10

clientRequestId10: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId11

clientRequestId11: object

parameterPath

parameterPath: string[] = ["options","poolDisableAutoScaleOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId12

clientRequestId12: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId13

clientRequestId13: object

parameterPath

parameterPath: string[] = ["options","poolEvaluateAutoScaleOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId14

clientRequestId14: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId15

clientRequestId15: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId16

clientRequestId16: object

parameterPath

parameterPath: string[] = ["options","poolUpdatePropertiesOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId17

clientRequestId17: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId18

clientRequestId18: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId19

clientRequestId19: object

parameterPath

parameterPath: string[] = ["options","poolListNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId2

clientRequestId2: object

parameterPath

parameterPath: string[] = ["options","applicationListNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId20

clientRequestId20: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId21

clientRequestId21: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId22

clientRequestId22: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId23

clientRequestId23: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId24

clientRequestId24: object

parameterPath

parameterPath: string[] = ["options","jobGetAllLifetimeStatisticsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId25

clientRequestId25: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId26

clientRequestId26: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId27

clientRequestId27: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId28

clientRequestId28: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId29

clientRequestId29: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId3

clientRequestId3: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId30

clientRequestId30: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId31

clientRequestId31: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId32

clientRequestId32: object

parameterPath

parameterPath: string[] = ["options","jobAddOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId33

clientRequestId33: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId34

clientRequestId34: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId35

clientRequestId35: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId36

clientRequestId36: object

parameterPath

parameterPath: string[] = ["options","jobGetTaskCountsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId37

clientRequestId37: object

parameterPath

parameterPath: string[] = ["options","jobListNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId38

clientRequestId38: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId39

clientRequestId39: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId4

clientRequestId4: object

parameterPath

parameterPath: string[] = ["options","poolGetAllLifetimeStatisticsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId40

clientRequestId40: object

parameterPath

parameterPath: string[] = ["options","certificateAddOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId41

clientRequestId41: object

parameterPath

parameterPath: string[] = ["options","certificateListOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId42

clientRequestId42: object

parameterPath

parameterPath: string[] = ["options","certificateCancelDeletionOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId43

clientRequestId43: object

parameterPath

parameterPath: string[] = ["options","certificateDeleteMethodOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId44

clientRequestId44: object

parameterPath

parameterPath: string[] = ["options","certificateGetOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId45

clientRequestId45: object

parameterPath

parameterPath: string[] = ["options","certificateListNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId46

clientRequestId46: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromTaskOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId47

clientRequestId47: object

parameterPath

parameterPath: string[] = ["options","fileGetFromTaskOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId48

clientRequestId48: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromTaskOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId49

clientRequestId49: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromComputeNodeOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId5

clientRequestId5: object

parameterPath

parameterPath: string[] = ["options","poolAddOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId50

clientRequestId50: object

parameterPath

parameterPath: string[] = ["options","fileGetFromComputeNodeOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId51

clientRequestId51: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromComputeNodeOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId52

clientRequestId52: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId53

clientRequestId53: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId54

clientRequestId54: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId55

clientRequestId55: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId56

clientRequestId56: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId57

clientRequestId57: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId58

clientRequestId58: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId59

clientRequestId59: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId6

clientRequestId6: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId60

clientRequestId60: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId61

clientRequestId61: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId62

clientRequestId62: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId63

clientRequestId63: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId64

clientRequestId64: object

parameterPath

parameterPath: string[] = ["options","jobScheduleAddOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId65

clientRequestId65: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId66

clientRequestId66: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId67

clientRequestId67: object

parameterPath

parameterPath: string[] = ["options","taskAddOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId68

clientRequestId68: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId69

clientRequestId69: object

parameterPath

parameterPath: string[] = ["options","taskAddCollectionOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId7

clientRequestId7: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId70

clientRequestId70: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId71

clientRequestId71: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId72

clientRequestId72: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId73

clientRequestId73: object

parameterPath

parameterPath: string[] = ["options","taskListSubtasksOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId74

clientRequestId74: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId75

clientRequestId75: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId76

clientRequestId76: object

parameterPath

parameterPath: string[] = ["options","taskListNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId77

clientRequestId77: object

parameterPath

parameterPath: string[] = ["options","computeNodeAddUserOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId78

clientRequestId78: object

parameterPath

parameterPath: string[] = ["options","computeNodeDeleteUserOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId79

clientRequestId79: object

parameterPath

parameterPath: string[] = ["options","computeNodeUpdateUserOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId8

clientRequestId8: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId80

clientRequestId80: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId81

clientRequestId81: object

parameterPath

parameterPath: string[] = ["options","computeNodeRebootOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId82

clientRequestId82: object

parameterPath

parameterPath: string[] = ["options","computeNodeReimageOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId83

clientRequestId83: object

parameterPath

parameterPath: string[] = ["options","computeNodeDisableSchedulingOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId84

clientRequestId84: object

parameterPath

parameterPath: string[] = ["options","computeNodeEnableSchedulingOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId85

clientRequestId85: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteLoginSettingsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId86

clientRequestId86: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteDesktopOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId87

clientRequestId87: object

parameterPath

parameterPath: string[] = ["options","computeNodeUploadBatchServiceLogsOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId88

clientRequestId88: object

parameterPath

parameterPath: string[] = ["options","computeNodeListOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId89

clientRequestId89: object

parameterPath

parameterPath: string[] = ["options","computeNodeListNextOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const clientRequestId9

clientRequestId9: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","clientRequestId"]

mapper

mapper: object

serializedName

serializedName: string = "client-request-id"

type

type: object

name

name: "Uuid" = "Uuid"

Const endTime

endTime: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","endTime"]

mapper

mapper: object

serializedName

serializedName: string = "endtime"

type

type: object

name

name: "DateTime" = "DateTime"

Const expand0

expand0: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand1

expand1: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand2

expand2: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand3

expand3: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand4

expand4: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand5

expand5: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand6

expand6: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand7

expand7: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const expand8

expand8: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const filePath

filePath: object

parameterPath

parameterPath: string = "filePath"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "filePath"

type

type: object

name

name: "String" = "String"

Const filter0

filter0: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter1

filter1: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter10

filter10: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter11

filter11: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter12

filter12: object

parameterPath

parameterPath: string[] = ["options","computeNodeListOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter2

filter2: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter3

filter3: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter4

filter4: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter5

filter5: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter6

filter6: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter7

filter7: object

parameterPath

parameterPath: string[] = ["options","certificateListOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter8

filter8: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter9

filter9: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const ifMatch0

ifMatch0: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch1

ifMatch1: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch10

ifMatch10: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch11

ifMatch11: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch12

ifMatch12: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch13

ifMatch13: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch14

ifMatch14: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch15

ifMatch15: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch16

ifMatch16: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch17

ifMatch17: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch18

ifMatch18: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch19

ifMatch19: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch2

ifMatch2: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch20

ifMatch20: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch21

ifMatch21: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch22

ifMatch22: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch23

ifMatch23: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch24

ifMatch24: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch25

ifMatch25: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch26

ifMatch26: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch27

ifMatch27: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch3

ifMatch3: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch4

ifMatch4: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch5

ifMatch5: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch6

ifMatch6: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch7

ifMatch7: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch8

ifMatch8: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifMatch9

ifMatch9: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifModifiedSince0

ifModifiedSince0: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince1

ifModifiedSince1: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince10

ifModifiedSince10: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince11

ifModifiedSince11: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince12

ifModifiedSince12: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince13

ifModifiedSince13: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince14

ifModifiedSince14: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince15

ifModifiedSince15: object

parameterPath

parameterPath: string[] = ["options","fileGetFromTaskOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince16

ifModifiedSince16: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromTaskOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince17

ifModifiedSince17: object

parameterPath

parameterPath: string[] = ["options","fileGetFromComputeNodeOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince18

ifModifiedSince18: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromComputeNodeOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince19

ifModifiedSince19: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince2

ifModifiedSince2: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince20

ifModifiedSince20: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince21

ifModifiedSince21: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince22

ifModifiedSince22: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince23

ifModifiedSince23: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince24

ifModifiedSince24: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince25

ifModifiedSince25: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince26

ifModifiedSince26: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince27

ifModifiedSince27: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince28

ifModifiedSince28: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince29

ifModifiedSince29: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince3

ifModifiedSince3: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince30

ifModifiedSince30: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince31

ifModifiedSince31: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince4

ifModifiedSince4: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince5

ifModifiedSince5: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince6

ifModifiedSince6: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince7

ifModifiedSince7: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince8

ifModifiedSince8: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifModifiedSince9

ifModifiedSince9: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","ifModifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Modified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifNoneMatch0

ifNoneMatch0: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch1

ifNoneMatch1: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch10

ifNoneMatch10: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch11

ifNoneMatch11: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch12

ifNoneMatch12: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch13

ifNoneMatch13: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch14

ifNoneMatch14: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch15

ifNoneMatch15: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch16

ifNoneMatch16: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch17

ifNoneMatch17: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch18

ifNoneMatch18: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch19

ifNoneMatch19: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch2

ifNoneMatch2: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch20

ifNoneMatch20: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch21

ifNoneMatch21: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch22

ifNoneMatch22: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch23

ifNoneMatch23: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch24

ifNoneMatch24: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch25

ifNoneMatch25: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch26

ifNoneMatch26: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch27

ifNoneMatch27: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch3

ifNoneMatch3: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch4

ifNoneMatch4: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch5

ifNoneMatch5: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch6

ifNoneMatch6: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch7

ifNoneMatch7: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch8

ifNoneMatch8: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch9

ifNoneMatch9: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const ifUnmodifiedSince0

ifUnmodifiedSince0: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince1

ifUnmodifiedSince1: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince10

ifUnmodifiedSince10: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince11

ifUnmodifiedSince11: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince12

ifUnmodifiedSince12: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince13

ifUnmodifiedSince13: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince14

ifUnmodifiedSince14: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince15

ifUnmodifiedSince15: object

parameterPath

parameterPath: string[] = ["options","fileGetFromTaskOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince16

ifUnmodifiedSince16: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromTaskOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince17

ifUnmodifiedSince17: object

parameterPath

parameterPath: string[] = ["options","fileGetFromComputeNodeOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince18

ifUnmodifiedSince18: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromComputeNodeOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince19

ifUnmodifiedSince19: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince2

ifUnmodifiedSince2: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince20

ifUnmodifiedSince20: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince21

ifUnmodifiedSince21: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince22

ifUnmodifiedSince22: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince23

ifUnmodifiedSince23: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince24

ifUnmodifiedSince24: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince25

ifUnmodifiedSince25: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince26

ifUnmodifiedSince26: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince27

ifUnmodifiedSince27: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince28

ifUnmodifiedSince28: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince29

ifUnmodifiedSince29: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince3

ifUnmodifiedSince3: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince30

ifUnmodifiedSince30: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince31

ifUnmodifiedSince31: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince4

ifUnmodifiedSince4: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince5

ifUnmodifiedSince5: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince6

ifUnmodifiedSince6: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince7

ifUnmodifiedSince7: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince8

ifUnmodifiedSince8: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ifUnmodifiedSince9

ifUnmodifiedSince9: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","ifUnmodifiedSince"]

mapper

mapper: object

serializedName

serializedName: string = "If-Unmodified-Since"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const jobId

jobId: object

parameterPath

parameterPath: string = "jobId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

Const jobScheduleId

jobScheduleId: object

parameterPath

parameterPath: string = "jobScheduleId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobScheduleId"

type

type: object

name

name: "String" = "String"

Const maxResults0

maxResults0: object

parameterPath

parameterPath: string[] = ["options","applicationListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults1

maxResults1: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults10

maxResults10: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults11

maxResults11: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults12

maxResults12: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults13

maxResults13: object

parameterPath

parameterPath: string[] = ["options","computeNodeListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults2

maxResults2: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults3

maxResults3: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults4

maxResults4: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 10

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 10

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults5

maxResults5: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults6

maxResults6: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults7

maxResults7: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults8

maxResults8: object

parameterPath

parameterPath: string[] = ["options","certificateListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const maxResults9

maxResults9: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const nodeId

nodeId: object

parameterPath

parameterPath: string = "nodeId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nodeId"

type

type: object

name

name: "String" = "String"

Const ocpDate0

ocpDate0: object

parameterPath

parameterPath: string[] = ["options","applicationListOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate1

ocpDate1: object

parameterPath

parameterPath: string[] = ["options","applicationGetOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate10

ocpDate10: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate11

ocpDate11: object

parameterPath

parameterPath: string[] = ["options","poolDisableAutoScaleOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate12

ocpDate12: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate13

ocpDate13: object

parameterPath

parameterPath: string[] = ["options","poolEvaluateAutoScaleOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate14

ocpDate14: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate15

ocpDate15: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate16

ocpDate16: object

parameterPath

parameterPath: string[] = ["options","poolUpdatePropertiesOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate17

ocpDate17: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate18

ocpDate18: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate19

ocpDate19: object

parameterPath

parameterPath: string[] = ["options","poolListNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate2

ocpDate2: object

parameterPath

parameterPath: string[] = ["options","applicationListNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate20

ocpDate20: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate21

ocpDate21: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate22

ocpDate22: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate23

ocpDate23: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate24

ocpDate24: object

parameterPath

parameterPath: string[] = ["options","jobGetAllLifetimeStatisticsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate25

ocpDate25: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate26

ocpDate26: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate27

ocpDate27: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate28

ocpDate28: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate29

ocpDate29: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate3

ocpDate3: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate30

ocpDate30: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate31

ocpDate31: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate32

ocpDate32: object

parameterPath

parameterPath: string[] = ["options","jobAddOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate33

ocpDate33: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate34

ocpDate34: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate35

ocpDate35: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate36

ocpDate36: object

parameterPath

parameterPath: string[] = ["options","jobGetTaskCountsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate37

ocpDate37: object

parameterPath

parameterPath: string[] = ["options","jobListNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate38

ocpDate38: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate39

ocpDate39: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate4

ocpDate4: object

parameterPath

parameterPath: string[] = ["options","poolGetAllLifetimeStatisticsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate40

ocpDate40: object

parameterPath

parameterPath: string[] = ["options","certificateAddOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate41

ocpDate41: object

parameterPath

parameterPath: string[] = ["options","certificateListOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate42

ocpDate42: object

parameterPath

parameterPath: string[] = ["options","certificateCancelDeletionOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate43

ocpDate43: object

parameterPath

parameterPath: string[] = ["options","certificateDeleteMethodOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate44

ocpDate44: object

parameterPath

parameterPath: string[] = ["options","certificateGetOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate45

ocpDate45: object

parameterPath

parameterPath: string[] = ["options","certificateListNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate46

ocpDate46: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromTaskOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate47

ocpDate47: object

parameterPath

parameterPath: string[] = ["options","fileGetFromTaskOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate48

ocpDate48: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromTaskOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate49

ocpDate49: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromComputeNodeOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate5

ocpDate5: object

parameterPath

parameterPath: string[] = ["options","poolAddOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate50

ocpDate50: object

parameterPath

parameterPath: string[] = ["options","fileGetFromComputeNodeOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate51

ocpDate51: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromComputeNodeOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate52

ocpDate52: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate53

ocpDate53: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate54

ocpDate54: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate55

ocpDate55: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate56

ocpDate56: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate57

ocpDate57: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate58

ocpDate58: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate59

ocpDate59: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate6

ocpDate6: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate60

ocpDate60: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate61

ocpDate61: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate62

ocpDate62: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate63

ocpDate63: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate64

ocpDate64: object

parameterPath

parameterPath: string[] = ["options","jobScheduleAddOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate65

ocpDate65: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate66

ocpDate66: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate67

ocpDate67: object

parameterPath

parameterPath: string[] = ["options","taskAddOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate68

ocpDate68: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate69

ocpDate69: object

parameterPath

parameterPath: string[] = ["options","taskAddCollectionOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate7

ocpDate7: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate70

ocpDate70: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate71

ocpDate71: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate72

ocpDate72: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate73

ocpDate73: object

parameterPath

parameterPath: string[] = ["options","taskListSubtasksOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate74

ocpDate74: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate75

ocpDate75: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate76

ocpDate76: object

parameterPath

parameterPath: string[] = ["options","taskListNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate77

ocpDate77: object

parameterPath

parameterPath: string[] = ["options","computeNodeAddUserOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate78

ocpDate78: object

parameterPath

parameterPath: string[] = ["options","computeNodeDeleteUserOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate79

ocpDate79: object

parameterPath

parameterPath: string[] = ["options","computeNodeUpdateUserOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate8

ocpDate8: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate80

ocpDate80: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate81

ocpDate81: object

parameterPath

parameterPath: string[] = ["options","computeNodeRebootOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate82

ocpDate82: object

parameterPath

parameterPath: string[] = ["options","computeNodeReimageOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate83

ocpDate83: object

parameterPath

parameterPath: string[] = ["options","computeNodeDisableSchedulingOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate84

ocpDate84: object

parameterPath

parameterPath: string[] = ["options","computeNodeEnableSchedulingOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate85

ocpDate85: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteLoginSettingsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate86

ocpDate86: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteDesktopOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate87

ocpDate87: object

parameterPath

parameterPath: string[] = ["options","computeNodeUploadBatchServiceLogsOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate88

ocpDate88: object

parameterPath

parameterPath: string[] = ["options","computeNodeListOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate89

ocpDate89: object

parameterPath

parameterPath: string[] = ["options","computeNodeListNextOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpDate9

ocpDate9: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","ocpDate"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-date"

type

type: object

name

name: "DateTimeRfc1123" = "DateTimeRfc1123"

Const ocpRange0

ocpRange0: object

parameterPath

parameterPath: string[] = ["options","fileGetFromTaskOptions","ocpRange"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-range"

type

type: object

name

name: "String" = "String"

Const ocpRange1

ocpRange1: object

parameterPath

parameterPath: string[] = ["options","fileGetFromComputeNodeOptions","ocpRange"]

mapper

mapper: object

serializedName

serializedName: string = "ocp-range"

type

type: object

name

name: "String" = "String"

Const poolId

poolId: object

parameterPath

parameterPath: string = "poolId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "poolId"

type

type: object

name

name: "String" = "String"

Const recursive

recursive: object

parameterPath

parameterPath: string[] = ["options","recursive"]

mapper

mapper: object

serializedName

serializedName: string = "recursive"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId0

returnClientRequestId0: object

parameterPath

parameterPath: string[] = ["options","applicationListOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId1

returnClientRequestId1: object

parameterPath

parameterPath: string[] = ["options","applicationGetOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId10

returnClientRequestId10: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId11

returnClientRequestId11: object

parameterPath

parameterPath: string[] = ["options","poolDisableAutoScaleOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId12

returnClientRequestId12: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId13

returnClientRequestId13: object

parameterPath

parameterPath: string[] = ["options","poolEvaluateAutoScaleOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId14

returnClientRequestId14: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId15

returnClientRequestId15: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId16

returnClientRequestId16: object

parameterPath

parameterPath: string[] = ["options","poolUpdatePropertiesOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId17

returnClientRequestId17: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId18

returnClientRequestId18: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId19

returnClientRequestId19: object

parameterPath

parameterPath: string[] = ["options","poolListNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId2

returnClientRequestId2: object

parameterPath

parameterPath: string[] = ["options","applicationListNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId20

returnClientRequestId20: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId21

returnClientRequestId21: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId22

returnClientRequestId22: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId23

returnClientRequestId23: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId24

returnClientRequestId24: object

parameterPath

parameterPath: string[] = ["options","jobGetAllLifetimeStatisticsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId25

returnClientRequestId25: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId26

returnClientRequestId26: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId27

returnClientRequestId27: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId28

returnClientRequestId28: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId29

returnClientRequestId29: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId3

returnClientRequestId3: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId30

returnClientRequestId30: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId31

returnClientRequestId31: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId32

returnClientRequestId32: object

parameterPath

parameterPath: string[] = ["options","jobAddOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId33

returnClientRequestId33: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId34

returnClientRequestId34: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId35

returnClientRequestId35: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId36

returnClientRequestId36: object

parameterPath

parameterPath: string[] = ["options","jobGetTaskCountsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId37

returnClientRequestId37: object

parameterPath

parameterPath: string[] = ["options","jobListNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId38

returnClientRequestId38: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId39

returnClientRequestId39: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId4

returnClientRequestId4: object

parameterPath

parameterPath: string[] = ["options","poolGetAllLifetimeStatisticsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId40

returnClientRequestId40: object

parameterPath

parameterPath: string[] = ["options","certificateAddOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId41

returnClientRequestId41: object

parameterPath

parameterPath: string[] = ["options","certificateListOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId42

returnClientRequestId42: object

parameterPath

parameterPath: string[] = ["options","certificateCancelDeletionOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId43

returnClientRequestId43: object

parameterPath

parameterPath: string[] = ["options","certificateDeleteMethodOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId44

returnClientRequestId44: object

parameterPath

parameterPath: string[] = ["options","certificateGetOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId45

returnClientRequestId45: object

parameterPath

parameterPath: string[] = ["options","certificateListNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId46

returnClientRequestId46: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromTaskOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId47

returnClientRequestId47: object

parameterPath

parameterPath: string[] = ["options","fileGetFromTaskOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId48

returnClientRequestId48: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromTaskOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId49

returnClientRequestId49: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromComputeNodeOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId5

returnClientRequestId5: object

parameterPath

parameterPath: string[] = ["options","poolAddOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId50

returnClientRequestId50: object

parameterPath

parameterPath: string[] = ["options","fileGetFromComputeNodeOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId51

returnClientRequestId51: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromComputeNodeOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId52

returnClientRequestId52: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId53

returnClientRequestId53: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId54

returnClientRequestId54: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId55

returnClientRequestId55: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId56

returnClientRequestId56: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId57

returnClientRequestId57: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId58

returnClientRequestId58: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId59

returnClientRequestId59: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId6

returnClientRequestId6: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId60

returnClientRequestId60: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId61

returnClientRequestId61: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId62

returnClientRequestId62: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId63

returnClientRequestId63: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId64

returnClientRequestId64: object

parameterPath

parameterPath: string[] = ["options","jobScheduleAddOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId65

returnClientRequestId65: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId66

returnClientRequestId66: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId67

returnClientRequestId67: object

parameterPath

parameterPath: string[] = ["options","taskAddOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId68

returnClientRequestId68: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId69

returnClientRequestId69: object

parameterPath

parameterPath: string[] = ["options","taskAddCollectionOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId7

returnClientRequestId7: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId70

returnClientRequestId70: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId71

returnClientRequestId71: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId72

returnClientRequestId72: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId73

returnClientRequestId73: object

parameterPath

parameterPath: string[] = ["options","taskListSubtasksOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId74

returnClientRequestId74: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId75

returnClientRequestId75: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId76

returnClientRequestId76: object

parameterPath

parameterPath: string[] = ["options","taskListNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId77

returnClientRequestId77: object

parameterPath

parameterPath: string[] = ["options","computeNodeAddUserOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId78

returnClientRequestId78: object

parameterPath

parameterPath: string[] = ["options","computeNodeDeleteUserOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId79

returnClientRequestId79: object

parameterPath

parameterPath: string[] = ["options","computeNodeUpdateUserOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId8

returnClientRequestId8: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId80

returnClientRequestId80: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId81

returnClientRequestId81: object

parameterPath

parameterPath: string[] = ["options","computeNodeRebootOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId82

returnClientRequestId82: object

parameterPath

parameterPath: string[] = ["options","computeNodeReimageOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId83

returnClientRequestId83: object

parameterPath

parameterPath: string[] = ["options","computeNodeDisableSchedulingOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId84

returnClientRequestId84: object

parameterPath

parameterPath: string[] = ["options","computeNodeEnableSchedulingOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId85

returnClientRequestId85: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteLoginSettingsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId86

returnClientRequestId86: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteDesktopOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId87

returnClientRequestId87: object

parameterPath

parameterPath: string[] = ["options","computeNodeUploadBatchServiceLogsOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId88

returnClientRequestId88: object

parameterPath

parameterPath: string[] = ["options","computeNodeListOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId89

returnClientRequestId89: object

parameterPath

parameterPath: string[] = ["options","computeNodeListNextOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const returnClientRequestId9

returnClientRequestId9: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","returnClientRequestId"]

mapper

mapper: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "return-client-request-id"

type

type: object

name

name: "Boolean" = "Boolean"

Const select0

select0: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select1

select1: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select10

select10: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select11

select11: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select12

select12: object

parameterPath

parameterPath: string[] = ["options","taskListSubtasksOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select13

select13: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select14

select14: object

parameterPath

parameterPath: string[] = ["options","computeNodeListOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select2

select2: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select3

select3: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select4

select4: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select5

select5: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select6

select6: object

parameterPath

parameterPath: string[] = ["options","certificateListOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select7

select7: object

parameterPath

parameterPath: string[] = ["options","certificateGetOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select8

select8: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const select9

select9: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: "String" = "String"

Const startTime

startTime: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","startTime"]

mapper

mapper: object

serializedName

serializedName: string = "starttime"

type

type: object

name

name: "DateTime" = "DateTime"

Const taskId

taskId: object

parameterPath

parameterPath: string = "taskId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const thumbprint

thumbprint: object

parameterPath

parameterPath: string = "thumbprint"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "thumbprint"

type

type: object

name

name: "String" = "String"

Const thumbprintAlgorithm

thumbprintAlgorithm: object

parameterPath

parameterPath: string = "thumbprintAlgorithm"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "thumbprintAlgorithm"

type

type: object

name

name: "String" = "String"

Const timeout0

timeout0: object

parameterPath

parameterPath: string[] = ["options","applicationListOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout1

timeout1: object

parameterPath

parameterPath: string[] = ["options","applicationGetOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout10

timeout10: object

parameterPath

parameterPath: string[] = ["options","poolDisableAutoScaleOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout11

timeout11: object

parameterPath

parameterPath: string[] = ["options","poolEnableAutoScaleOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout12

timeout12: object

parameterPath

parameterPath: string[] = ["options","poolEvaluateAutoScaleOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout13

timeout13: object

parameterPath

parameterPath: string[] = ["options","poolResizeOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout14

timeout14: object

parameterPath

parameterPath: string[] = ["options","poolStopResizeOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout15

timeout15: object

parameterPath

parameterPath: string[] = ["options","poolUpdatePropertiesOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout16

timeout16: object

parameterPath

parameterPath: string[] = ["options","poolRemoveNodesOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout17

timeout17: object

parameterPath

parameterPath: string[] = ["options","accountListNodeAgentSkusOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout18

timeout18: object

parameterPath

parameterPath: string[] = ["options","accountListPoolNodeCountsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout19

timeout19: object

parameterPath

parameterPath: string[] = ["options","jobGetAllLifetimeStatisticsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout2

timeout2: object

parameterPath

parameterPath: string[] = ["options","poolListUsageMetricsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout20

timeout20: object

parameterPath

parameterPath: string[] = ["options","jobDeleteMethodOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout21

timeout21: object

parameterPath

parameterPath: string[] = ["options","jobGetOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout22

timeout22: object

parameterPath

parameterPath: string[] = ["options","jobPatchOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout23

timeout23: object

parameterPath

parameterPath: string[] = ["options","jobUpdateOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout24

timeout24: object

parameterPath

parameterPath: string[] = ["options","jobDisableOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout25

timeout25: object

parameterPath

parameterPath: string[] = ["options","jobEnableOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout26

timeout26: object

parameterPath

parameterPath: string[] = ["options","jobTerminateOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout27

timeout27: object

parameterPath

parameterPath: string[] = ["options","jobAddOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout28

timeout28: object

parameterPath

parameterPath: string[] = ["options","jobListOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout29

timeout29: object

parameterPath

parameterPath: string[] = ["options","jobListFromJobScheduleOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout3

timeout3: object

parameterPath

parameterPath: string[] = ["options","poolGetAllLifetimeStatisticsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout30

timeout30: object

parameterPath

parameterPath: string[] = ["options","jobListPreparationAndReleaseTaskStatusOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout31

timeout31: object

parameterPath

parameterPath: string[] = ["options","jobGetTaskCountsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout32

timeout32: object

parameterPath

parameterPath: string[] = ["options","certificateAddOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout33

timeout33: object

parameterPath

parameterPath: string[] = ["options","certificateListOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout34

timeout34: object

parameterPath

parameterPath: string[] = ["options","certificateCancelDeletionOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout35

timeout35: object

parameterPath

parameterPath: string[] = ["options","certificateDeleteMethodOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout36

timeout36: object

parameterPath

parameterPath: string[] = ["options","certificateGetOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout37

timeout37: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromTaskOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout38

timeout38: object

parameterPath

parameterPath: string[] = ["options","fileGetFromTaskOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout39

timeout39: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromTaskOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout4

timeout4: object

parameterPath

parameterPath: string[] = ["options","poolAddOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout40

timeout40: object

parameterPath

parameterPath: string[] = ["options","fileDeleteFromComputeNodeOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout41

timeout41: object

parameterPath

parameterPath: string[] = ["options","fileGetFromComputeNodeOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout42

timeout42: object

parameterPath

parameterPath: string[] = ["options","fileGetPropertiesFromComputeNodeOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout43

timeout43: object

parameterPath

parameterPath: string[] = ["options","fileListFromTaskOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout44

timeout44: object

parameterPath

parameterPath: string[] = ["options","fileListFromComputeNodeOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout45

timeout45: object

parameterPath

parameterPath: string[] = ["options","jobScheduleExistsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout46

timeout46: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDeleteMethodOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout47

timeout47: object

parameterPath

parameterPath: string[] = ["options","jobScheduleGetOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout48

timeout48: object

parameterPath

parameterPath: string[] = ["options","jobSchedulePatchOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout49

timeout49: object

parameterPath

parameterPath: string[] = ["options","jobScheduleUpdateOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout5

timeout5: object

parameterPath

parameterPath: string[] = ["options","poolListOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout50

timeout50: object

parameterPath

parameterPath: string[] = ["options","jobScheduleDisableOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout51

timeout51: object

parameterPath

parameterPath: string[] = ["options","jobScheduleEnableOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout52

timeout52: object

parameterPath

parameterPath: string[] = ["options","jobScheduleTerminateOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout53

timeout53: object

parameterPath

parameterPath: string[] = ["options","jobScheduleAddOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout54

timeout54: object

parameterPath

parameterPath: string[] = ["options","jobScheduleListOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout55

timeout55: object

parameterPath

parameterPath: string[] = ["options","taskAddOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout56

timeout56: object

parameterPath

parameterPath: string[] = ["options","taskListOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout57

timeout57: object

parameterPath

parameterPath: string[] = ["options","taskAddCollectionOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout58

timeout58: object

parameterPath

parameterPath: string[] = ["options","taskDeleteMethodOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout59

timeout59: object

parameterPath

parameterPath: string[] = ["options","taskGetOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout6

timeout6: object

parameterPath

parameterPath: string[] = ["options","poolDeleteMethodOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout60

timeout60: object

parameterPath

parameterPath: string[] = ["options","taskUpdateOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout61

timeout61: object

parameterPath

parameterPath: string[] = ["options","taskListSubtasksOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout62

timeout62: object

parameterPath

parameterPath: string[] = ["options","taskTerminateOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout63

timeout63: object

parameterPath

parameterPath: string[] = ["options","taskReactivateOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout64

timeout64: object

parameterPath

parameterPath: string[] = ["options","computeNodeAddUserOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout65

timeout65: object

parameterPath

parameterPath: string[] = ["options","computeNodeDeleteUserOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout66

timeout66: object

parameterPath

parameterPath: string[] = ["options","computeNodeUpdateUserOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout67

timeout67: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout68

timeout68: object

parameterPath

parameterPath: string[] = ["options","computeNodeRebootOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout69

timeout69: object

parameterPath

parameterPath: string[] = ["options","computeNodeReimageOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout7

timeout7: object

parameterPath

parameterPath: string[] = ["options","poolExistsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout70

timeout70: object

parameterPath

parameterPath: string[] = ["options","computeNodeDisableSchedulingOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout71

timeout71: object

parameterPath

parameterPath: string[] = ["options","computeNodeEnableSchedulingOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout72

timeout72: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteLoginSettingsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout73

timeout73: object

parameterPath

parameterPath: string[] = ["options","computeNodeGetRemoteDesktopOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout74

timeout74: object

parameterPath

parameterPath: string[] = ["options","computeNodeUploadBatchServiceLogsOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout75

timeout75: object

parameterPath

parameterPath: string[] = ["options","computeNodeListOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout8

timeout8: object

parameterPath

parameterPath: string[] = ["options","poolGetOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const timeout9

timeout9: object

parameterPath

parameterPath: string[] = ["options","poolPatchOptions","timeout"]

mapper

mapper: object

defaultValue

defaultValue: number = 30

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Number" = "Number"

Const userName

userName: object

parameterPath

parameterPath: string = "userName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "userName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc